From d154a5de5c022f9a9da70bdad9a882c67324e547 Mon Sep 17 00:00:00 2001 From: squidfunk Date: Mon, 21 Aug 2023 17:48:11 +0200 Subject: [PATCH 1/2] Fixed documentation build --- docs/blog/.authors.yml | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/docs/blog/.authors.yml b/docs/blog/.authors.yml index 1e2b34d3b..e5fbca3e7 100644 --- a/docs/blog/.authors.yml +++ b/docs/blog/.authors.yml @@ -1,4 +1,5 @@ -squidfunk: - name: Martin Donath - description: Creator - avatar: https://avatars.githubusercontent.com/u/932156 +authors: + squidfunk: + name: Martin Donath + description: Creator + avatar: https://avatars.githubusercontent.com/u/932156 From 6c8cd470fdb76cc6ab0247b31ee5276eba591364 Mon Sep 17 00:00:00 2001 From: Sigurd Spieckermann <2206639+sisp@users.noreply.github.com> Date: Mon, 21 Aug 2023 18:18:21 +0200 Subject: [PATCH 2/2] Improved development environment setup instructions (#5876) --- docs/customization.md | 32 +++++++++++++++++++++++++------- 1 file changed, 25 insertions(+), 7 deletions(-) diff --git a/docs/customization.md b/docs/customization.md index b52797dcd..e448db7c2 100644 --- a/docs/customization.md +++ b/docs/customization.md @@ -235,20 +235,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 ```