Incorporating the Stripe API look and feel into a MadCap Flare project

Back in July, we looked at creating an API documentation portal using MadCap Flare (see also: Example of API documentation portal using MadCap Flare) .

We done some further testing. We’ve created two new examples for  API documentation that had been generated with the Stripe API look and feel and imported into Flare:

To compare the two, here is the standard “Stripe API” left-hand Table of Contents when imported into Flare.

We’ve not made any changes to the default Heading styles from the source files. The stylesheets would needed to be modified to make them consistent with the styles used on the other HTML pages in the project.

Update

Here is screenshot and a link to an example Help file, where the OpenAPI file has been imported into Flare, using the Markdown import. The Markdown file has been imported, but no amendments have been made to the look and feel.

It also includes a second API reference example, where the content is displayed in HTML format.

 

Screenshot of API documentation in MadCap Flare

Example file of API documentation in MadCap Flare

One Comment

Leave a Reply

Your email address will not be published. Required fields are marked *

This site uses Akismet to reduce spam. Learn how your comment data is processed.