mirror of
https://github.com/qodo-ai/pr-agent.git
synced 2025-07-05 13:20:39 +08:00
15 lines
565 B
Markdown
15 lines
565 B
Markdown
|
# 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](https://squidfunk.github.io/mkdocs-material/)
|
||
|
|
|
||
|
|
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](https://codium-ai.github.io/docs/)
|
||
|
|
|
||
|
|
Github action is located in `.github/workflows/ci.yml` file.
|