Installation¶

Requirements¶

• Python 3.12 or higher

• Astral uv as recommended Python package manager

• MkDocs

Basic Installation¶

Thanks to the modern Python package manager, you can easily install the plugin using the following commands:

uv init
uv venv
uv add mkdocs-note

After installation, you can use the mkdocs-note --version command to check the version of the plugin.

mkdocs-note --version

Or you can use The uv tool Interface (uvx) to install and use it much simpler that run the plugin in an isolated environment:

uvx mkdocs-note --version

Or using pip in an old way:

pip install mkdocs-note

For developers¶

If you want to contribute to the plugin, you can clone the repository and install the plugin in development mode:

git clone https://github.com/virtualguard101/mkdocs-note.git
cd mkdocs-note
uv sync --extra dev
uv add -e .

Then you can run the tests for installation verification:

uv run pytest

More details about development setup, please refer to Contributing.