Skip to content

Commit 786af83

Browse files
Merge pull request #63 from virtualguard101/dev
docs: update readme
2 parents 9bdfd45 + 5603bdf commit 786af83

1 file changed

Lines changed: 4 additions & 16 deletions

File tree

README.md

Lines changed: 4 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -20,32 +20,20 @@ MkDocs Note is a plugin for [MkDocs](https://www.mkdocs.org/) that automatically
2020
>[!IMPORTANT]
2121
> **Breaking Changes**
2222
>
23-
> 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.
23+
> 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.
2424
>
25-
> However, you need to manually move your existing assets to the new location.
26-
>
27-
> By the way, I think the plugin after `v2.0.0` can not only as a "notebook manager", but also an efficient documentations manager because of its powerful and flexible asset management system.
25+
> More details are available in the [Changelog](https://blog.virtualguard101.com/mkdocs-note/about/changelog/#300---2025-11-04-Architecture-Simplification) and [pull request #60](https://github.com/virtualguard101/mkdocs-note/pull/60).
2826
2927
## Features
3028

3129
- **Recent Notes Display**: Automatically displays a list of recent notes on your notes index page
3230

33-
<!-- - **Multi-format Support**: Supports both Markdown (.md) and Jupyter Notebook (.ipynb) files -->
34-
35-
- **Smart Filtering**: Excludes index files and other specified patterns from the recent notes list
36-
3731
- **Flexible Configuration**: Highly customizable note directory, file patterns, and display options
3832

39-
- **Automatic Updates**: Notes list updates automatically when you build your documentation
40-
41-
- **Command Line Interface**: Built-in CLI commands for note management (`mkdocs note init`, `mkdocs note new`, etc.)
33+
- **Command Line Interface**: Built-in CLI commands for note management ( `mkdocs note new`, `mkdocs note mv`, etc.)
4234

4335
- **Asset Management**: Automatic asset directory creation and management for each note
4436

45-
- **Template System**: Configurable note templates with variable substitution
46-
47-
- **Structure Validation**: Ensures compliant asset tree structure for consistent organization
48-
4937
- **Network Graph Visualization**: Interactive network graph showing relationships between notes with automatic link detection
5038

5139
## Installation
@@ -77,7 +65,7 @@ plugins:
7765
- mkdocs-note
7866
```
7967
80-
The usage and configuration details are available in the [Mkdocs-Based Documentation](https://blog.virtualguard101.com/mkdocs-note) since `v2.0.0`, refer it to get help or more infomation.
68+
The usage and configuration details are available in the [Mkdocs-Based Documentation](https://blog.virtualguard101.com/mkdocs-note) since `v2`, refer it to get help or more infomation.
8169

8270
## Contributing
8371

0 commit comments

Comments
 (0)