Saturday, August 05, 2017

API Documentation with Tabs for Languages

Slate generates html from a markdown document and provides syntax highlighting for different languages that displays in separate tabs.

For internal use, API blueprint is a good option. For external use, slate is a great option to publish documentation. It generates good looking and developer friendly docs. We can copy the slate generated static files to a static site deployed on Google cloud. This is the easiest deployment. It avoids extra work that is required with AWS such as uploading to S3, configuring a bucket as a webserver etc.


1. Is slate markdown compatible with API blueprint markdown file (.apib) ?
2. Is there a tool that will convert .apib file to slate markdown file?

I started with the schema.rb file from a Rails project that I am currently working on.


- Using API Blueprint With MSON
- HTTP Documentation with API Blueprint