Skip to content

Commit 85f0d74

Browse files
committed
Merge branch 'master' into merge/piri-piri
2 parents ac30daa + 6c8cd47 commit 85f0d74

File tree

1 file changed

+22
-4
lines changed

1 file changed

+22
-4
lines changed

docs/customization.md

+22-4
Original file line numberDiff line numberDiff line change
@@ -237,20 +237,38 @@ directly in the source of the theme and recompile it.
237237

238238
### Environment setup
239239

240-
In order to start development on Material for MkDocs, a [Node.js] version of
241-
at least 18 is required. First, clone the repository:
240+
First, clone the repository:
242241

243242
```
244243
git clone https://github.com/squidfunk/mkdocs-material
244+
cd mkdocs-material
245245
```
246246

247-
Next, all dependencies need to be installed, which is done with:
247+
Next, create a new [Python virtual environment][venv] and
248+
[activate][venv-activate] it:
249+
250+
```
251+
python -m venv .venv
252+
source .venv/bin/activate
253+
```
254+
255+
[venv]: https://docs.python.org/3/library/venv.html
256+
[venv-activate]: https://docs.python.org/3/library/venv.html#how-venvs-work
257+
258+
Then, install all Python dependencies:
248259

249260
```
250-
cd mkdocs-material
251261
pip install -e .
252262
pip install mkdocs-minify-plugin
253263
pip install mkdocs-redirects
264+
pip install nodeenv
265+
```
266+
267+
Finally, install the [Node.js] LTS version into the Python virtual environment
268+
and install all Node.js dependencies:
269+
270+
```
271+
python -m nodeenv -p -n lts
254272
npm install
255273
```
256274

0 commit comments

Comments
 (0)