Skip to content
Bofu Chen edited this page Sep 13, 2020 · 8 revisions

Introduction

There are two essential branches

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

Local Run

  1. Switch to the source branch.

  2. Run the command

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

Depolyment

  1. Build the latest source.

     $ mkdocs build
    
  2. Collect the updates.

  3. Switch to the master branch.

  4. Commit the updates.

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

Tips

  1. How to write indent code blocks?

    Refer to this clear solution.

Clone this wiki locally