yours-truly works with protagonist to generate an HTML version of your API


This is a node.js APIBlueprint formatter for producing HTML documents.

It uses protagonist and ejs to do all the dirty work.

For writing API documentation, read up on the APIBlueprint specification.

Here's a small sample:

Example API
A simple API example
Group People
This section describes the People endpoint
## Person [/people/{id}]
Represent a particular Person
+ Parameters
    + id (required, string, `123`) ... The id of the Person.
+ Model (application/json)
### Retrieve Person [GET]
Return the information for the Person
+ Response 200 (application/json)
$ ./node_modules/bin/yours-truly [OUTPUT_FILE.html]
1. Create your API markdown file, e.g. ``
1. Run `./node_modules/bin/yours-truly`
1. Pipe the output somewhere
1. Done!
1. Create your API markdown file, e.g. ``
1. Run `./node_modules/bin/yours-truly blueprint.html`
1. Done!
- Trying to view the output HTML file in your browser directly from the filesystem will not display correctly.

If the GO language is more your thing, you might want to check out these projects