Skip to content

Commit

Permalink
docs(local-dev): add pdm install step
Browse files Browse the repository at this point in the history
Based on a discussion in #33729, it was missing from the local dev doc.
  • Loading branch information
mathisgauthey authored Jan 24, 2025
1 parent cbf5303 commit 126c909
Showing 1 changed file with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions docs/development/local-development.md
Original file line number Diff line number Diff line change
Expand Up @@ -177,6 +177,7 @@ If you're only working on the documentation files, you can use the `pnpm doc-fix
## Documentation

We use [MkDocs](https://www.mkdocs.org) to generate the documentation.
To install the required dependency, use `pdm install`.
You can run `pnpm build:docs` to generate the docs.
Then use `pnpm mkdocs serve` to preview the documentation locally.
The docs will update automatically when you run `pnpm build:docs` again, no need to stop the `pnpm mkdocs serve` command.
Expand Down

0 comments on commit 126c909

Please sign in to comment.