Skip to content

Instantly share code, notes, and snippets.

@dtolb

dtolb/authoring_with_viewsaurus.md

Forked from acamino/authoring_with_viewsaurus.md
Created May 25, 2016 04:17
Show Gist options
  • Save dtolb/30ab42fba888fa670acd1c27534c997c to your computer and use it in GitHub Desktop.
Save dtolb/30ab42fba888fa670acd1c27534c997c to your computer and use it in GitHub Desktop.
Download ZIP
Authoring with viewsaurus
Raw
authoring_with_viewsaurus.md

Authoring with Viewsaurus

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

The tool we're using to write the tutorials made our work so easy, I really enjoyed working with viewsaurus.

If you need to use this package, here are the instructions to set up viewsaurus.

Assumptions

You have installed Node.js, if not you should installed to use this guide.

Steps

  1. Install viewsaurus package:
npm install viewsaurus -g
  1. Open your tutorial directory:
cd <your tutorial directory>
  1. Create a new branch gh-pages:
git checkout -b gh-pages
  1. Initialize the tutorial:
saurus new
  1. Start authoring:
saurus author
  1. Visit http://localhost:8080 to see the tutorial running.

Notes

  • You can edit tutorial/config.json as appropriate for the project.
  • Update tutorial/index.jade as needed.

See Also

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment