You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+4-16Lines changed: 4 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -20,32 +20,20 @@ MkDocs Note is a plugin for [MkDocs](https://www.mkdocs.org/) that automatically
20
20
>[!IMPORTANT]
21
21
> **Breaking Changes**
22
22
>
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.
24
24
>
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).
28
26
29
27
## Features
30
28
31
29
-**Recent Notes Display**: Automatically displays a list of recent notes on your notes index page
32
30
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
-**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.)
42
34
43
35
-**Asset Management**: Automatic asset directory creation and management for each note
44
36
45
-
-**Template System**: Configurable note templates with variable substitution
46
-
47
-
-**Structure Validation**: Ensures compliant asset tree structure for consistent organization
48
-
49
37
-**Network Graph Visualization**: Interactive network graph showing relationships between notes with automatic link detection
50
38
51
39
## Installation
@@ -77,7 +65,7 @@ plugins:
77
65
- mkdocs-note
78
66
```
79
67
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.
0 commit comments