For documenting we using gitbook. It employs markdown files with little wrapper structure to allow you to write well formatted content in a snap, keeping a git version control.
- Install gitbook client tool
npm install -g gitbook-cli- Clone our docs repo:
git clone https://github.com/netbeast/docs.git- Serve it locally
cd docs
gitbook install
gitbook serve- Open a new shell or open it with your favorite editor
atom /path/to/docs###Once you are done Make a pull request!
git checkout -b "branch_name"
git add -A
git commit -m "adds my chapter to the docs"
git push origin "branch_name"