Name: website_user_docs
Owner: Melbourne Bioinformatics
Description: User documentation for VLSCI website
Created: 2014-11-06 05:55:55.0
Updated: 2014-11-06 05:55:55.0
Pushed: 2015-01-05 02:48:50.0
Homepage: null
Size: 568
Language: null
GitHub Committers
| User | Most Recent Commit | # Commits |
|---|
Other Committers
| User | Most Recent Commit | # Commits |
|---|
We are using the Python package MkDocs.
I recommend installing MkDocs into a virtualenv:
ualenv mkdocs_dev
ce mkdocs_dev/bin/activate
install -U mkdocs
Once you have mkdocs installed (and in your PATH) then you can preview the website by running the following command in the top directory of this repository:
cs serve
This will start up a web server hosting on a local URL, like so:
ing at: http://127.0.0.1:8000/
reload enabled.
ctrl+c to quit.
You can view the site if you point your browser at the specified URL.
MkDocs will automatically try to update the site if you edit the documentation pages.
You can build the site using the command:
cs build
This will put all the HTML, CSS, Javascript etcetera for the site in the directory called site.
The pages are written in Markdown.