Documentation for ICGC DCC using [mkdocs](http://www.mkdocs.org/) and GitHub Pages hosted at [http://icgc-dcc.github.io/dcc-docs](http://icgc-dcc.github.io/dcc-docs)
npm install dcc-docsDocumentation for ICGC DCC using mkdocs and GitHub Pages hosted at http://icgc-dcc.github.io/dcc-docs
A custom domain is setup on the gh-pages branch in the CNAME file:
mkdocs version 0.15.3 or higher.To install on Mac:
``bash`
brew install mkdocs
Node is also required. Download the latest version from nodejs.org.
After installing node, cd into the directory containing the project and run`
npm install
The content of the docs are Markdown documents that may be found at docs/
:warning: Note that you must commit your changes to GitHub in order for them not to be clobbered by another user in a future deployment.
Edit mkdocs.yml
`shell`
npm start
`shell`
npm run build
To publish changes, run
`shell`
npm run publish
It is not necessary to run the build task before publishing
If errors are encountered when running npm run build|publish, try re-running
`shell``
npm install
to update missing packages used by the doc deployment process.