Contributing to the Docs

These docs are generated using MkDocs with the Material for MkDocs theme.

Getting Started

Clone the repo and change into the docs directory:

git clone git@github.com:lightningkite/mui-lightning-components.git
cd mui-lightning-components/docs

Install mkdocs and the Material theme:

pip install mkdocs
pip install mkdocs-material

Serve the docs locally on port 8000 with hot reloading:

mkdocs serve

To add a new page, create a new markdown file in the docs directory, then add it to the nav section of mkdocs.yml

To deploy changes to the docs:

mkdocs gh-deploy