Skip to content

Commit 6c8cd47

Browse files
authored
Improved development environment setup instructions (#5876)
1 parent d154a5d commit 6c8cd47

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
@@ -235,20 +235,38 @@ directly in the source of the theme and recompile it.
235235

236236
### Environment setup
237237

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

241240
```
242241
git clone https://github.com/squidfunk/mkdocs-material
242+
cd mkdocs-material
243243
```
244244

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

247258
```
248-
cd mkdocs-material
249259
pip install -e .
250260
pip install mkdocs-minify-plugin
251261
pip install mkdocs-redirects
262+
pip install nodeenv
263+
```
264+
265+
Finally, install the [Node.js] LTS version into the Python virtual environment
266+
and install all Node.js dependencies:
267+
268+
```
269+
python -m nodeenv -p -n lts
252270
npm install
253271
```
254272

0 commit comments

Comments
 (0)