Home

Introduction

There are two essential branches

1. master: contains documentation source code (Material for MkDocs).
2. gh-pages: contains documentation deployment (HTML).

Local Run

1. Switch to the master branch.

2. Run the command

    $ mkdocs serve
   

3. Open the URL http://localhost:8000 in browser.

Depolyment

1. Run the command

    $ mkdocs gh-deploy
   

2. (one-time) Set GitHub Pages to the gh-pages branch.

3. Open the URL http://doc.berrynet.org in browser.

Tips

1. How to write indent code blocks?

   Refer to this clear solution.