Mine docs for the indoor library
GPL-3.0 License
this is a step-by-step guide documentation made using the material for Mk docs a powerful static site generator geared towards building project documentation. Documentation source files are written in Markdown, and configured with a single YAML configuration file.
pip install mkdocs-material
This will automatically install compatible versions of all dependencies: MkDocs, Markdown, Pygments and Python Markdown Extensions.
docker pull squidfunk/mkdocs-material
git clone https://github.com/squidfunk/mkdocs-material.git
cd mkdocs-material
pip install -e .
MkDocs material is built on top of MkDocs, which is uses python markdown to convert markdown files to html.
inside the project directory, run the following command:
python -m venv env
then activate the virtual environment:
source env/bin/activate
then run the server:
mkdocs serve
Congratulations! you have successfully run the server, now you can access the documentation
this project contains a github action that will automatically deploy the documentation to github pages when a new commit is pushed to the main branch. you can find the github action file in the .github/workflows directory.
If you find this project helpful or interesting, please consider giving it a ⭐️. It really helps us out by:
Happy coding!