File tree Expand file tree Collapse file tree 1 file changed +13
-11
lines changed
Expand file tree Collapse file tree 1 file changed +13
-11
lines changed Original file line number Diff line number Diff line change 22
33The Django Commons docs are deployed at [ django-commons.org] ( https://django-commons.org ) .
44
5- ## MkDocs Commands
6-
7- * ` mkdocs new [dir-name] ` - Create a new project.
8- * ` mkdocs serve ` - Start the live-reloading docs server.
9- * ` mkdocs build ` - Build the documentation site.
10- * ` mkdocs -h ` - Print help message and exit.
11-
125## Local Development
136
14- - Create a Python 3.12 virtual environment
15- - Run ` pip install mkdocs `
16- - Run ` mkdocs serve `
7+ 1 . Create a Python 3.13 virtual environment (` uv venv --python 3.13 ` )
8+ 2 . Run ` pip install mkdocs `
9+ 3 . Run ` mkdocs serve `
10+
11+ With uv: ` uv run --python 3.13 --with mkdocs mkdocs serve `
1712
1813### pre-commit
1914
2015You don't have to use pre-commit. But if you choose to:
2116
22- - Run ` pip install pre-commit`
17+ 1 . [ Install pre-commit] ( https://pre-commit.com/#installation )
2318- Run ` pre-commit install `
2419
2520This will install pre-commit. Then, before you commit, run ` pre-commit run ` to run pre-commit and check your changed files for linting errors.
21+
22+ ## MkDocs Commands
23+
24+ * ` mkdocs new [dir-name] ` - Create a new project.
25+ * ` mkdocs serve ` - Start the live-reloading docs server.
26+ * ` mkdocs build ` - Build the documentation site.
27+ * ` mkdocs -h ` - Print help message and exit.
You can’t perform that action at this time.
0 commit comments