This directory contains the MkDocs documentation site using the Material theme.
Install required dependencies:
uv pip install mkdocs "mkdocs-material[imaging]"Build and serve the documentation locally:
cd docs/mkdocs
uv run mkdocs build
uv run mkdocs serve -a localhost:9999View at: http://localhost:9999
Deploy to GitHub Pages:
cd docs/mkdocs
uv run mkdocs gh-deploy --forceLive site: https://miromindai.github.io/MiroFlow/
This function is not in use as we found that some theme functions are not available under mike.
For versioned documentation using Mike:
# Install Mike
uv pip install mike
# Set default version
uv run mike set-default v0.3
# Deploy with version
uv run mike deploy --push --update-aliases v0.3 latest
# Serve versioned docs locally
uv run mike serve -a localhost:9999