This is the HANDI-HOPD technical documentation, hosted at https://HOPD_website.github.io
- See http://handi-hopd.org for high-level project info and news
- Need help? Ask a question at http://groups.google.com/group/handi-hopd
- Found an error in these docs? Fork them on Github and send us a pull request!
First, you'll need the Jekyll static site generator installed. The full installation instructions are here, but you probaly can just do:
$ gem install jekyll
There are two other libraries to install to generate these documents:
-
redcarpet: our preferred Ruby Markdown processor.$ gem install redcarpet
-
Pygments: the Python-based syntax highligher, this installation instructions for which are at the bottom of the Jekyll page above.
Once the required software is installed, generating the static site (in
the _site directory) is simply running
$ jekyll serve --watch -b /
on the commandline.
If you prefer, you can serve the project with Node.js and grunt, which enables "live reload" behavior. This allows editing side-by-side with the web page; and every time you save, your changes appear automatically in the browser.
Just install nodejs and grunt, and then run:
npm install
grunt
And then open a brower to http://localhost:4000