The tiny-api-docs can be used as a lightweight alternative to Swagger or Slate.
It’s tiny because it needs just three files to work: the place when you write the content (content.md
), the file with stylings (github-markdown.css
), and the file that renders your docs (index.html
).
- Copy everything to a static directory on your server (e.g.:
api/docs
) , so it could serve theindex.html
file. - Edit the
content.md
for your own purpose. - Have fun!
- Markdown support (thanks to marked).
- Clean styling (thanks to github-markdown-css)
- Table of Contents (thanks to tocbot)
- Clean column layout (thanks to Bootstrap)
- Single file edition.