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
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.
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file mkdocs_note-3.2.0.tar.gz.
File metadata
- Download URL: mkdocs_note-3.2.0.tar.gz
- Upload date:
- Size: 74.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
uv/0.12.1 {"installer":{"name":"uv","version":"0.12.1","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}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
b2665f4eeb5949069a67ed293fb5b93df9090750b10c6357589aea0ed7110919
|
|
| MD5 |
4a57e7000fb04830040070d2c91bcb0a
|
|
| BLAKE2b-256 |
3f86288e0a419361cf82b1051ff7bfcdfed1d4ffa6fcdb0bd8731dd5b64afa38
|
File details
Details for the file mkdocs_note-3.2.0-py3-none-any.whl.
File metadata
- Download URL: mkdocs_note-3.2.0-py3-none-any.whl
- Upload date:
- Size: 66.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
uv/0.12.1 {"installer":{"name":"uv","version":"0.12.1","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}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
39867283c2e7ac696d661fcde4bc953e21ed97d78b3d77a54d8e88d148cc9786
|
|
| MD5 |
6c88a7b1dfad00bc63ec0a41eb368495
|
|
| BLAKE2b-256 |
2de42e85df32470f526ecf29385db9c159c609eeff51d9814248d50d4712191d
|
