Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update development environment setup documentation #5919

Merged
merged 3 commits into from
Sep 18, 2023
+4 −4
Merged

Update development environment setup documentation #5919

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9f320b5
Instruct to create Python virtual env in `venv` instead of `.venv` di…
sisp Aug 29, 2023
b299112
Instruct to run `nodeenv` executable instead of Python module
sisp Aug 29, 2023
63fdbb1
Instruct to build also theme overrides before submitting a PR
sisp Aug 29, 2023
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
8 changes: 4 additions & 4 deletions docs/customization.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -248,8 +248,8 @@ Next, create a new [Python virtual environment][venv] and
[activate][venv-activate] it:

```
python -m venv .venv
source .venv/bin/activate
python -m venv venv
source venv/bin/activate
```

[venv]: https://docs.python.org/3/library/venv.html
Expand All @@ -268,7 +268,7 @@ Finally, install the [Node.js] LTS version into the Python virtual environment
and install all Node.js dependencies:

```
python -m nodeenv -p -n lts
nodeenv -p -n lts
npm install
```

Expand Down Expand Up @@ -310,7 +310,7 @@ npm run build # (1)!
1. While this command will build all theme files, it will skip the overrides
used in Material for MkDocs' own documentation which are not distributed
with the theme. If you forked the theme and want to build the overrides
as well, use:
as well, e.g. before submitting a PR with changes, use:

```
npm run build:all
Expand Down