Developer Docs using MkDocs

This is the public repository for Developer Docs

This project has been built using the exceptional MkDocs project.

For full documentation visit mkdocs.org.

QuickStart

# Requires Python; from this directory:
pip install mkdocs
pip install mkdocs-material
mkdocs serve

The docs will be served locally on http://localhost:8000

Commands

• pip install mkdocs - Install MkDocs (Requires Python)
• pip install mkdocs-material - Install Material theme for MkDocs
• mkdocs new [dir-name] - Create a new project.
• mkdocs serve - Start the live-reloading docs server.
• 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.

Deployment

Auto-deploy via GitHub actions, take a peek! 👁️