An API documentation theme
Carte is a simple Jekyll based documentation website for APIs. It is designed as a boilerplate to build your own documentation and is heavily inspired from Swagger and I/O docs.
Fork it, add specifications for your APIs calls and customize the theme. Go ahead, see if we care.
We built Carte because the existing options (Swagger and the likes) were trying to do too much and did not match our needs:
- Most of our API calls are sending JSON objects, as opposed to a series of parameters,
- Being able to query the real API is nice, but running anything but GET calls can get tricky (“What do you mean I deleted my stuff? I was just trying out the API calls!”),
- Overall, setting up a separate server for what really requires a good static documentation seemed overkill.
The real value of Carte is its structure for describing APIs, not its underlying technical stack (or lack-thereof). In a nutshell; we built a static template for your API documentation, feel free to re-use it.