Skip to content

Viewsaurus tool used by Twillio for tutorials.

License

Notifications You must be signed in to change notification settings

Xenar0/viewsaurus

 
 

Repository files navigation

Viewsaurus

A Viewsaurus is an interactive tutorial for documentation portals.

Demo

Getting Started

Before You Begin

Steps

  1. Fork this repo
  2. Clone your forked repo - git clone git@github.com:{yourusername}/viewsaurus.git
  3. Open your directory - cd viewsaurus
  4. Install viewsaurus globally - npm install viewsaurus -g
  5. Start the tutorial locally - saurus author
  6. View the tutorial at http://localhost:8080

Making Your Own

To make your own tutorial, follow these instructions.

  1. Check out master - git checkout master
  2. Edit tutorial/config.json
  3. Start the tutorial from scratch - saurus new
  4. Start the tutorial locally - saurus author
  5. View the tutorial at http://localhost:8080
  6. Make changes to tutorial/index.jade as desired

Resources

License

MIT

About

Viewsaurus tool used by Twillio for tutorials.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 70.1%
  • CSS 22.9%
  • HTML 7.0%