Skip to content

Commit

Permalink
Merge branch 'master' into merge/piri-piri
Browse files Browse the repository at this point in the history
  • Loading branch information
squidfunk committed Aug 21, 2023
2 parents ac30daa + 6c8cd47 commit 85f0d74
Showing 1 changed file with 22 additions and 4 deletions.
26 changes: 22 additions & 4 deletions docs/customization.md
Original file line number Diff line number Diff line change
Expand Up @@ -237,20 +237,38 @@ directly in the source of the theme and recompile it.

### Environment setup

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

```
git clone https://github.com/squidfunk/mkdocs-material
cd mkdocs-material
```

Next, all dependencies need to be installed, which is done with:
Next, create a new [Python virtual environment][venv] and
[activate][venv-activate] it:

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

[venv]: https://docs.python.org/3/library/venv.html
[venv-activate]: https://docs.python.org/3/library/venv.html#how-venvs-work

Then, install all Python dependencies:

```
cd mkdocs-material
pip install -e .
pip install mkdocs-minify-plugin
pip install mkdocs-redirects
pip install nodeenv
```

Finally, install the [Node.js] LTS version into the Python virtual environment
and install all Node.js dependencies:

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

Expand Down

0 comments on commit 85f0d74

Please sign in to comment.