This is the Documentations for 96rocks. You can view the documents at the docs.96rocks.com. This documents is hosted on Github Page with custom domain at gh-pages branch. The master branch is the souce for the documents.

The documents is generated by Hugo, a static site generator.

For apt based Linux such as Debian or Ubuntu:

sudo apt-get install hugo

For MacOS:

brew install hugo

Other platform please refer Hugo install documents.

Fork the repo and clone it

git clone --recurse https://github.com/96rocks/docs.96rocks.com.git
cd docs.96rocks.com
hugo server

The output is like below:

...
Serving pages from memory
Web Server is available at http://localhost:1313/ (bind address 127.0.0.1)
Press Ctrl+C to stop

Open your browser, go to http://localhost:1313/ and you can view the docs locally.

We use git’s worktree feature to checkout the gh-pages branch at public folder(which hugo will generate all the html to). Essentially, the worktree allows you to have multiple branches of the same local repository to be checked out in different directories.

Run

./publish.sh
cd public
git branch

You should see the gh-pages branch.

The documents are under content directory, starting with _index.en.md(with multiple language support). You can copy and paste the exsiting files to start new sections. Put all the images in one image directory. Hugo can auto refresh if there is any file changes. Commit and push the change to your repo if the preview is ok and send pull request from the master branch. We will merge it and update the gh-pages branch. Updating gh-pages branch is live instantly. Your contribution will be automatically added to the credit section once merged.