Authoring Tutorials with Viewsaurus

Recently I've been writing a few tutorials for Twilio, so far it was a pleasant experience. It's always fun to play with a nice API in the languages you like, right?

The tool we're using to write these tutorials made our work easy. I enjoyed working with viewsaurus.

If you have to use this viewsaurus, here are the instructions to set it up.

Assumptions

You have installed Node.js.

Steps

1. Install viewsaurus package

   $ npm install viewsaurus -g

2. Open your tutorial directory

   $ cd path/to/your/repo

3. Checkout a new branch gh-pages, if it doesn't exist of course 😉

   $ git checkout -b gh-pages

4. Start the tutorial from scratch

   $ saurus new

5. Authoring the tutorial

   $ saurus author

6. Visit http://localhost:8080 to see the tutorial in action.

Notes

• Edit tutorial/config.json as appropriate for the project.
• Update tutorial/index.jade as needed.

---

See Also

• Installing Node.js
• Jade Template Engine
• Mastering Markdown