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
-
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.
1 maintainer
Metadata
1 maintainer
Release files for mkdocs-note 3.3.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| mkdocs_note-3.3.1.tar.gz | 79.5 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| mkdocs_note-3.3.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 148.0 kB
Release files / mkdocs_note-3.3.1.tar.gz
| Download URL | mkdocs_note-3.3.1.tar.gz |
|---|---|
| Size | 79.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
6d217f882eab901b446608bb9128a6b965b7970392884aa923c495b1f8586c17
|
|
BLAKE2b-256 checksum How to use checksums |
c960ce87cfc6d9a975d53ec9f9724df81fff261de79a4a3b79114c131c4c13be
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
uv/0.12.10 {"installer":{"name":"uv","version":"0.12.10","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.3.1-py3-none-any.whl
| Download URL | mkdocs_note-3.3.1-py3-none-any.whl |
|---|---|
| Size | 68.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
a96dc008e169a2303fe1b211fa0db395a3366f1b1a4d62a908d3d5ebf3d4fa88
|
|
BLAKE2b-256 checksum How to use checksums |
d5f4ebb901b24ff1d348683ed230b2263d1377a4901fd9adde6fc114b6ee1c59
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
uv/0.12.10 {"installer":{"name":"uv","version":"0.12.10","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}
|
