Skip to content

Latest commit

 

History

History
19 lines (11 loc) · 784 Bytes

README.md

File metadata and controls

19 lines (11 loc) · 784 Bytes

Confab Docs

Documentation for Confab Comments, hosted at docs.confabcomments.com. See the main Confab repo for more information about this project.

Setting Up Dev Environment

Install Python, then install mkdocs-material and required plugins using the following command:

pip install mkdocs-material=="9.*" mkdocs-awesome-pages-plugin mkdocs-markdownextradata-plugin

Make sure that mkdocs is accessible from the terminal, mkdocs.exe should be stored in a directory in PATH. pip install command should tell you whether the directory needs to be added to PATH.

Development and Building

mkdocs serve to start the local server during development.

mkdocs build to build the site.