Skip to content

Commit 32fdc0b

Browse files
committed
Add deployment documentation.
1 parent f3927ac commit 32fdc0b

File tree

2 files changed

+21
-0
lines changed

2 files changed

+21
-0
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
src/site/

README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,26 @@ You don't have to use pre-commit. But if you choose to:
2121

2222
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.
2323

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+
2444
## MkDocs Commands
2545

2646
* `mkdocs new [dir-name]` - Create a new project.

0 commit comments

Comments
 (0)