pr-agent/docs
2024-03-06 22:22:37 +02:00
..
.cache/plugin/social Add documentation portal with MKDocs 2024-03-06 21:52:11 +02:00
docs Add documentation portal with MKDocs 2024-03-06 21:52:11 +02:00
overrides/partials Add documentation portal with MKDocs 2024-03-06 21:52:11 +02:00
site Add documentation portal with MKDocs 2024-03-06 21:52:11 +02:00
mkdocs.yml Add documentation portal with MKDocs 2024-03-06 21:52:11 +02:00
README.md Update README.md 2024-03-06 22:22:37 +02:00

To install:

pip install mkdocs pip install mkdocs-material pip install mkdocs-material-extensions pip install "mkdocs-material[imaging]"

docs

To run localy: mkdocs serve

To expand and customize the theme: Material MKDocs

The deployment is managed on the gh-pages branches. After each merge to main the deplloyment will be taken care of by GH action automatically and the new version will be available at: Docs

Github action is located in .github/workflows/ci.yml file.