Write new documentation

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.

1. Install gitbook client tool

   npm install -g gitbook-cli
   

2. Clone our docs repo:

   git clone https://github.com/netbeast/docs.git
   

3. Serve it locally

   cd docs
   gitbook install
   gitbook serve
   

4. 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"

References

Gitbook github