Name: dcc-docs
Owner: ICGC DCC
Description: User facing documentation for ICGC DCC at http://docs.icgc.org/
Created: 2015-12-03 16:35:12.0
Updated: 2016-10-25 14:38:56.0
Pushed: 2017-12-20 15:07:46.0
Size: 46635
Language: CSS
GitHub Committers
User | Most Recent Commit | # Commits |
---|
Other Committers
User | Most Recent Commit | # Commits |
---|
Documentation 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:
This project requires mkdocs
version 0.15.3 or higher.
To install on Mac:
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
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
start
run build
Changes are published through Netlify.
You can either run the build step and copy over the site
directory to netlify, or have netlify watch the master branch and
build and deploy it on changes.
If errors are encountered when running npm run build|publish, try re-running
install
to update missing packages used by the doc deployment process.