File tree Expand file tree Collapse file tree 2 files changed +5
-3
lines changed
Expand file tree Collapse file tree 2 files changed +5
-3
lines changed Original file line number Diff line number Diff line change @@ -7,10 +7,10 @@ The repository that hosts the docs is at https://github.com/django-commons/djang
77## Local Development
88
991 . Create a Python 3.13 virtual environment (` uv venv --python 3.13 ` )
10- 2 . Run ` pip install mkdocs `
10+ 2 . Run ` pip install mkdocs mkdocs-material `
11113 . Run ` mkdocs serve -f src/mkdocs.yml `
1212
13- With uv: ` uv run --python 3.13 --with mkdocs mkdocs serve -f src/mkdocs.yml `
13+ With uv: ` uv run --python 3.13 --with mkdocs --with mkdocs-material mkdocs serve -f src/mkdocs.yml `
1414
1515### pre-commit
1616
@@ -38,7 +38,7 @@ django-commons.github.io/
3838To deploy, run the following command from the ` django-commons.github.io/ ` directory.
3939
4040``` bash
41- uv run --python 3.13 --with mkdocs mkdocs gh-deploy --config-file ../django-commons-mkdocs/src/mkdocs.yml --remote-branch main
41+ uv run --python 3.13 --with mkdocs --with mkdocs-material mkdocs gh-deploy --config-file ../django-commons-mkdocs/src/mkdocs.yml --remote-branch main
4242```
4343
4444## MkDocs Commands
Original file line number Diff line number Diff line change @@ -3,6 +3,8 @@ repo_url: https://github.com/django-commons/django-commons.github.io
33markdown_extensions :
44 - toc :
55 permalink : " #"
6+ theme :
7+ name : material
68nav :
79 - Home : index.md
810 - FAQ : faq.md
You can’t perform that action at this time.
0 commit comments