Skip to content

Latest commit

 

History

History
50 lines (32 loc) · 1.43 KB

README.md

File metadata and controls

50 lines (32 loc) · 1.43 KB

SMART Technical Documentation

This is the SMART technical documentation, hosted at http://docs.smarthealthit.org

Installation

Jekyll and friends. (mandatory)

The SMART technical documentation is built using Ruby tools. Using Bundler, you can install all of the required dependencies to generate and run the documentation locally by running the following command from the smart-on-fhir.github.io/ directory:

$ bundle install

This will install Jekyll, a static site generator and redcarpet, a Ruby Markdown processor.

Once the required software is installed, generating the static site (in the _site directory) is simply running

$ jekyll serve --watch -b /

on the commandline.

Node and npm (optional)

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
npm run-script watch

And then open a browser to http://localhost:4000