Viewsaurus by Twilio

Viewsaurus helps you create awesome code walkthroughs for your open source projects. It's like view source, but 84% more awesome.

Authoring Tutorials 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

1. Open your tutorial directory

$ cd path/to/your/repo

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

$ git checkout -b gh-pages

1. Start the tutorial from scratch

$ saurus new

1. Authoring the tutorial

$ saurus author

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

License

MIT