Simply write beautiful API documentation.
This project started as a fork of the popular Slate API documentation tool, which uses ruby. Since I found the initial setup of Slate quite cumbersome, I started this NodeJS based project.
Check out a Whiteboard example API documentation.
Getting Started with Whiteboard
You're going to need:
Yes, that's it!
Getting Set Up
- Clone this repository to your hard drive with
git clone https://github.com/mpociot/whiteboard.git
- Install the dependencies:
- Start the test server:
Now go ahead and visit http://localhost:4000 and you will be presented with a beautiful example API documentation as a starting point.
Go ahead and modify the markdown file at
source/index.md to suit your needs.
Publishing your API documentation
The easiest way to publish your API documentation is using this command within your
npm run-script generate
This will generate a
public folder which you can upload anywhere you want.
Windows users: You need to install the global
npm install -g hexo-cli. To publish your API documentation under windows use
If you want other (more automated) deployment options like git, heroku, rsync or ftp - please take a look at the Hexo deployment documentation.
Generate the documentation programmatically
To generate the API documentation programmatically, for example in your automated build process, use the whiteboard module.
generate method will return a promise.
var Whiteboard = ;Whiteboard
Since both Whiteboard and Slate use regular markdown files to render the API documentation, your existing Slate API documentation should work just fine. If you encounter any issues, please submit an issue.
In depth documentation
Documentations built with Whiteboard
None yet - Feel free to submit a PR with a link to your documentation.
Whiteboard was built by Marcel Pociot.