Example API docs in Whiteboard

This is example API documentation that I put together as I worked through Tom Johnson’s terrific course on documenting REST APIs.

The basis for this documentation is this fictional wiki. I wanted to try a simple tri-pane tool, so I used Whiteboard to generate a neat and organized API doc set with code samples.

Whiteboard is a Node.js-based API docs generator that uses Markdown files to render the documentation. I originally wanted to use Slate, but I had trouble with the convoluted setup process that Whiteboard’s creator mentions in the project README.md.

If you’re curious, here’s the same doc set as a GitHub wiki written in rST (link to one of my GitHub repositories).

  • Git/GitHub
  • Markdown
  • reStructured Text (rst)
  • Sublime Text
  • Whiteboard