Skip to content

Latest commit

 

History

History
54 lines (34 loc) · 1.48 KB

README.md

File metadata and controls

54 lines (34 loc) · 1.48 KB

SMART Technical Documentation

This is the SMART technical documentation, hosted at https://smart-on-fhir.github.io

Installing Jekyll and Friends

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:

  1. redcarpet: our preferred Ruby Markdown processor.

    $ gem install redcarpet

  2. 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