User Guide Docs

User Guide

The user gides is available at: http://docs.grasshopper.ws/ . The user guide is to show a dev how to use Grasshopper in a project.

Contribution Guide

The contribution guide is available at: http://docs.grasshopper.ws/contribution-guide/ . The contribution guide is to describe how you can add to the functionality of Grasshopper.

Notes

These docs are built using mkdocs.

Pushing to the master branch rebuilds the docs on the server.

  • npm run user to serve the user guide.
  • npm run contribution to serve the contribution guide
  • npm run build to build both sets of docs from the project root.

Install mkdocs with pip.