diff --git a/docs/about/release-notes.md b/docs/about/release-notes.md index 5a11bc8a..37b50810 100644 --- a/docs/about/release-notes.md +++ b/docs/about/release-notes.md @@ -14,7 +14,7 @@ You can determine your currently installed version using `mkdocs --version`: ```console $ mkdocs --version -mkdocs, version 1.5.0 from /path/to/mkdocs (Python 3.10) +mkdocs, version 1.7.0 from /path/to/mkdocs (Python 3.12) ``` ## Maintenance team diff --git a/docs/getting-started.md b/docs/getting-started.md index 4a713c3d..9163d9aa 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -9,7 +9,7 @@ An introductory tutorial! To install MkDocs, run the following command from the command line: ```bash -pip install mkdocs +pip install mkdocs-ng ``` For more details, see the [Installation Guide]. diff --git a/docs/user-guide/installation.md b/docs/user-guide/installation.md index fbf0b918..44add06b 100644 --- a/docs/user-guide/installation.md +++ b/docs/user-guide/installation.md @@ -13,9 +13,9 @@ You can check if you already have these installed from the command line: ```console $ python --version -Python 3.8.2 +Python 3.12.0 $ pip --version -pip 20.0.2 from /usr/local/lib/python3.8/site-packages/pip (python 3.8) +pip 24.2 from /usr/local/lib/python3.12/site-packages/pip (python 3.12) ``` If you already have those packages installed, you may skip down to [Installing @@ -55,7 +55,7 @@ python get-pip.py Install the `mkdocs` package using pip: ```bash -pip install mkdocs +pip install mkdocs-ng ``` You should now have the `mkdocs` command installed on your system. Run `mkdocs @@ -63,7 +63,7 @@ You should now have the `mkdocs` command installed on your system. Run `mkdocs ```console $ mkdocs --version -mkdocs, version 1.2.0 from /usr/local/lib/python3.8/site-packages/mkdocs (Python 3.8) +mkdocs, version 1.7.0 from /usr/local/lib/python3.12/site-packages/mkdocs (Python 3.12) ``` > NOTE: @@ -86,14 +86,14 @@ mkdocs, version 1.2.0 from /usr/local/lib/python3.8/site-packages/mkdocs (Python > like this: > > ```bash -> python -m pip install mkdocs +> python -m pip install mkdocs-ng > python -m mkdocs > ``` > > For a more permanent solution, you may need to edit your `PATH` environment > variable to include the `Scripts` directory of your Python installation. > Recent versions of Python include a script to do this for you. Navigate to -> your Python installation directory (for example `C:\Python38\`), open the +> your Python installation directory (for example `C:\Python312\`), open the > `Tools`, then `Scripts` folder, and run the `win_add2path.py` file by double > clicking on it. Alternatively, you can download the [script][a2p] and run it > (`python win_add2path.py`). diff --git a/mkdocs.yml b/mkdocs.yml index 077ee6a8..933c19af 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,7 +1,7 @@ site_name: MkDocs site_url: https://mkdocs-ng.github.io/mkdocs/ site_description: Project documentation with Markdown. -site_author: MkDocs Team +site_author: MkDocs NG Team repo_url: https://github.com/mkdocs-ng/mkdocs/ edit_uri: blob/main/docs/ @@ -49,7 +49,7 @@ markdown_extensions: repo: mkdocs - mkdocs-click -copyright: Copyright © 2014 Tom Christie, Maintained by the MkDocs Team. +copyright: Copyright © 2014 Tom Christie, Maintained by the MkDocs NG Team. hooks: - docs/hooks.py diff --git a/pyproject.toml b/pyproject.toml index 7bce6463..c7d466df 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -208,6 +208,10 @@ check = ["markdown", "js", "css", "spelling"] path = "mkdocs.yml" [tool.hatch.envs.docs] detached = false +[tool.hatch.envs.docs.scripts] +build = "mkdocs build" +serve = "mkdocs serve" +deploy = "mkdocs gh-deploy" [tool.black] line-length = 100