Skip to content

Guziq/tiny-api-docs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

tiny-api-docs

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).

screenshot

Get Started

  1. Copy everything to a static directory on your server (e.g.: api/docs) , so it could serve the index.html file.
  2. Edit the content.md for your own purpose.
  3. Have fun!

Features

About

A tiny, markdown based framework for creating API docs

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published