update: template doc

Fleshmannnnnn · Sep 24, 2023 · a1f37d8 · a1f37d8
1 parent 9282b0a
commit a1f37d8
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/docs/about-note-template.md b/docs/about-note-template.md
@@ -198,6 +198,12 @@ Basic user template.
 
 ### Builtin Templates
 
+The name of builtin templates are not allowed to be modified.
+
+> Every time there is a breaking change, the corresponding builtin template will be updated and renamed to `{TEMPLATE_NAME}V{n+1}`, where `n` is the version number of the old builtin template and `{TEMPLATE_NAME}` is the name of the template. The old builtin template will be kept for compatibility.
+>
+> For example, the builtin template `[ExportMDFileNameV2]` may be renamed to `[ExportMDFileNameV3]` in the future.
+
 | Name                | Description                                              | Variables                             |
 | ------------------- | -------------------------------------------------------- | ------------------------------------- |
 | QuickInsert         | For forward link.                                        | link, linkText, subNoteItem, noteItem |