mkdocs-note 3.1.0

A MkDocs plugin to add note boxes to your documentation.

MkDocs Note

A MkDocs plugin to add note boxes to your documentation.

English | 简体中文

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

• MkDocs

• Material for MkDocs

• MkDocs Network Graph Plugin

License

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