MkDocs Note

A MkDocs plugin to add note boxes to your documentation.

Plugin Usage Demo: Notebook | virtualguard101's Wiki

MkDocs Note is a plugin for MkDocs that automatically manages notes in your documentation site. It's designed to work seamlessly with Material for MkDocs theme to create a unified note-taking and documentation experience.

[!IMPORTANT] Breaking Changes

Since v3, we greatly simplifies the plugin's framework architecture, and removed some features that are not essential to the core functionality of the plugin in order to make it more lightweight and easier to maintain.

More details are available in the Changelog and pull request #60.

Features

Recent Notes Display: Automatically displays a list of recent notes on your notes index page
Flexible Configuration: Highly customizable note directory, file patterns, and display options
Command Line Interface: Built-in CLI commands for note management ( mkdocs note new, mkdocs note mv, etc.)
Asset Management: Automatic asset directory creation and management for each note
Network Graph Visualization: Interactive network graph showing relationships between notes with automatic link detection
Same-site Link Preview: Opt-in hover cards for internal note links (summary or section excerpt)
Notion Sync: Sync your notes to Notion with ease CLI.

Installation

Recommended to use uv to manage python virtual environment:

uv init
uv venv
uv add mkdocs-note

Or use The uv tool Interface (uvx) to install and use it much simpler:

uvx mkdocs-note --help

Or using pip:

pip install mkdocs-note

Then, add the plugin to your mkdocs.yml:

plugins:
  - mkdocs-note

The usage and configuration details are available in the Mkdocs-Based Documentation since v2, refer it to get help or more infomation.

Contributing

Contributions are welcome! Please see the CONTRIBUTING.md file for guidelines.

References

License

This project is licensed under the GNU General Public License v3.0.

Metadata

Release files for mkdocs-note 3.4.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for mkdocs-note 3.4.0
File	Size	Uploaded
mkdocs_note-3.4.0.tar.gz	95.6 kB	Oct 1, 2026	Details

Built distribution (wheel)

Table of built distributions (wheels) for mkdocs-note 3.4.0
File	Interpreter	ABI	Platform	Reset
mkdocs_note-3.4.0-py3-none-any.whl 83.7 kB Oct 1, 2026	Python 3	none	any	Details

Total release size: 179.3 kB

Release files / mkdocs_note-3.4.0.tar.gz

Download URL	mkdocs_note-3.4.0.tar.gz
Size	95.6 kB
Tags	Source
SHA-256 checksum How to use checksums	`36a54dc7f855c3b7bff76da0db53f9185b445f15ed4f430cc71f9c40c6af8d3e`
BLAKE2b-256 checksum How to use checksums	`dd2cd6ce8bf7e61ed093bc34aaf47d544f07b75d942d144f17ddc1db85583e49`
Upload date	Oct 1, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	Yes
Uploaded via	`uv/0.12.21 {"installer":{"name":"uv","version":"0.12.21","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}`

Release files / mkdocs_note-3.4.0-py3-none-any.whl

Download URL	mkdocs_note-3.4.0-py3-none-any.whl
Size	83.7 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`8a685971f1d9c090dbc6bcc6c955c6c811783a9ecdf5624e2df8db271ad81fe9`
BLAKE2b-256 checksum How to use checksums	`a40cf0a1c1653e529b0889ff649124851506475ade2f4f3dcd8b6898ba868cae`
Upload date	Oct 1, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	Yes
Uploaded via	`uv/0.12.21 {"installer":{"name":"uv","version":"0.12.21","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}`