=======

singa-docs

Documentations for SINGA

Edit and Preview the Website

All documentations are written in Markdown format and located at _posts/.

If you have installed Jekyll, then you can preview the website by

jekyll serve --config _config.yml,_config-prod.yml --host 0.0.0.0

If you do not have Jekyll installed on your own computer, then your can follow these steps to preview the website on you own Github site:

fork SINGA to your own Github account from https://github.com/apache/incubator-singa.
clone SINGA from your Github to your local computer
edit the content (e.g., add documentations)
update the BASE_URL in _config.yml to "http://username.github.io/incubator-singa"
commit and push to your own Github repo
goto http://username.github.io/incubator-singa/

We used Jekyll-Boostrap MIT to generate this website.
The source code except that from Jekyll-Boostrap is release under Apache License 2.