File tree Expand file tree Collapse file tree 2 files changed +21
-0
lines changed Expand file tree Collapse file tree 2 files changed +21
-0
lines changed Original file line number Diff line number Diff line change
1
+ src /site /
Original file line number Diff line number Diff line change @@ -21,6 +21,26 @@ You don't have to use pre-commit. But if you choose to:
21
21
22
22
This will install pre-commit. Then, before you commit, run ` pre-commit run ` to run pre-commit and check your changed files for linting errors.
23
23
24
+ ## Deployment
25
+
26
+ The site is hosted using GitHub Pages which requires a separate repository.
27
+
28
+ If you have cloned both this repository and django-commons.github.io to the same parent directory as follows:
29
+
30
+ ```
31
+ django-commons-mkdocs/
32
+ src/
33
+ mkdocs.yml
34
+ docs/
35
+ django-commons.github.io/
36
+ ```
37
+
38
+ To deploy, run the following command from the ` django-commons.github.io/ ` directory.
39
+
40
+ ``` bash
41
+ uv run --python 3.13 --with mkdocs mkdocs gh-deploy --config-file ../django-commons-mkdocs/src/mkdocs.yml --remote-branch main
42
+ ```
43
+
24
44
## MkDocs Commands
25
45
26
46
* ` mkdocs new [dir-name] ` - Create a new project.
You can’t perform that action at this time.
0 commit comments