mkdocs-note 2.0.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 v2.0.0, the plugin uses a co-located asset structure instead of the old unified tree structure, where assets are stored next to their notes. This makes it easier to manage and move notes with their assets together.

However, you need to manually move your existing assets to the new location.

By the way, I think the plugin after v2.0.0 can not only as a "notebook manager", but also an efficient document manager because of it powerful and flexible asset management system.

Features

• Recent Notes Display: Automatically displays a list of recent notes on your notes index page

• Smart Filtering: Excludes index files and other specified patterns from the recent notes list

• Flexible Configuration: Highly customizable note directory, file patterns, and display options

• Automatic Updates: Notes list updates automatically when you build your documentation

• Command Line Interface: Built-in CLI commands for note management (mkdocs note init, mkdocs note new, etc.)

• Asset Management: Automatic asset directory creation and management for each note

• Template System: Configurable note templates with variable substitution

• Structure Validation: Ensures compliant asset tree structure for consistent organization

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.0.0, refer it to get help or more infomation.

Contributing

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

License

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