A Viewsaurus is an interactive tutorial for documentation portals.
- Install Node.js.
- Fork this repo
- Clone your forked repo -
git clone git@github.com:{yourusername}/viewsaurus.git - Open your directory -
cd viewsaurus - Install viewsaurus globally -
npm install viewsaurus -g - Start the tutorial locally -
saurus author - View the tutorial at http://localhost:8080
To make your own tutorial, follow these instructions.
- Check out master -
git checkout master - Edit
tutorial/config.json - Start the tutorial from scratch -
saurus new - Start the tutorial locally -
saurus author - View the tutorial at http://localhost:8080
- Make changes to
tutorial/index.jadeas desired
MIT