Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/about/release-notes.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -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].
Expand Down
12 changes: 6 additions & 6 deletions docs/user-guide/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -55,15 +55,15 @@ 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
--version` to check that everything worked okay.

```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:
Expand All @@ -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`).
Expand Down
4 changes: 2 additions & 2 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -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/
Expand Down Expand Up @@ -49,7 +49,7 @@ markdown_extensions:
repo: mkdocs
- mkdocs-click

copyright: Copyright &copy; 2014 <a href="https://twitter.com/starletdreaming">Tom Christie</a>, Maintained by the <a href="/about/release-notes/#maintenance-team">MkDocs Team</a>.
copyright: Copyright &copy; 2014 <a href="https://twitter.com/starletdreaming">Tom Christie</a>, Maintained by the <a href="/about/release-notes/#maintenance-team">MkDocs NG Team</a>.

hooks:
- docs/hooks.py
Expand Down
4 changes: 4 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading