Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 13 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,24 +2,26 @@

The Django Commons docs are deployed at [django-commons.org](https://django-commons.org).

## MkDocs Commands

* `mkdocs new [dir-name]` - Create a new project.
* `mkdocs serve` - Start the live-reloading docs server.
* `mkdocs build` - Build the documentation site.
* `mkdocs -h` - Print help message and exit.

## Local Development

- Create a Python 3.12 virtual environment
- Run `pip install mkdocs`
- Run `mkdocs serve`
1. Create a Python 3.13 virtual environment (`uv venv --python 3.13`)
2. Run `pip install mkdocs`
3. Run `mkdocs serve`

With uv: `uv run --python 3.13 --with mkdocs mkdocs serve`

### pre-commit

You don't have to use pre-commit. But if you choose to:

- Run `pip install pre-commit`
1. [Install pre-commit](https://pre-commit.com/#installation)
- Run `pre-commit install`

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.

## MkDocs Commands

* `mkdocs new [dir-name]` - Create a new project.
* `mkdocs serve` - Start the live-reloading docs server.
* `mkdocs build` - Build the documentation site.
* `mkdocs -h` - Print help message and exit.