C2SM User Landing Page

MkDocs

For full documentation visit mkdocs.org.

Material for MkDocs

For full documentation visit https://squidfunk.github.io/mkdocs-material/.

Install

python3 -m venv venv
source venv/bin/activate
pip install -r requirements.txt

Commands

• mkdocs new [dir-name] - Create a new project.
• mkdocs serve - Start the live-reloading docs server (open second terminal to make changes).
• mkdocs build - Build the documentation site.
• mkdocs -h - Print help message and exit.

Project layout

mkdocs.yml    # The configuration file.
docs/
    index.md  # The documentation homepage.
    ...       # Other markdown pages, images and other files.