1
0
mirror of https://github.com/squidfunk/mkdocs-material.git synced 2024-11-28 01:10:58 +01:00

Merge branch 'master' into merge/piri-piri

This commit is contained in:
squidfunk 2023-08-21 18:18:39 +02:00
commit 85f0d74ab5
No known key found for this signature in database
GPG Key ID: 5ED40BC4F9C436DF

View File

@ -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
```
Next, all dependencies need to be installed, which is done with:
```
cd mkdocs-material
```
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:
```
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
```