From c8374251482ecfd849dabec4f08133bac734ca84 Mon Sep 17 00:00:00 2001 From: saberzero1 Date: Sun, 24 May 2026 19:56:20 +0200 Subject: [PATCH] docs: inline bases into markdown --- docs/getting-started/NewPlugins.base | 2 +- docs/getting-started/whats-new.md | 22 ++++- docs/plugins/Plugins.base | 116 -------------------------- docs/plugins/index.md | 119 ++++++++++++++++++++++++++- 4 files changed, 140 insertions(+), 119 deletions(-) delete mode 100644 docs/plugins/Plugins.base diff --git a/docs/getting-started/NewPlugins.base b/docs/getting-started/NewPlugins.base index 8d080dc..c1b29ee 100644 --- a/docs/getting-started/NewPlugins.base +++ b/docs/getting-started/NewPlugins.base @@ -2,7 +2,7 @@ filters: and: - file.ext == "md" - file.inFolder("plugins") - - note.new-in-v5 == true + - note["new-in-v5"] == true properties: title: displayName: Plugin diff --git a/docs/getting-started/whats-new.md b/docs/getting-started/whats-new.md index f32c3a9..e1c43d3 100644 --- a/docs/getting-started/whats-new.md +++ b/docs/getting-started/whats-new.md @@ -153,7 +153,27 @@ Quartz 5 supports multiple locales out of the box. Set `locale: ja-JP` (or any s Plugins new to v5 (not available in v4): -![[NewPlugins.base]] +```base +filters: + and: + - file.ext == "md" + - file.inFolder("plugins") + - note["new-in-v5"] == true +properties: + title: + displayName: Plugin + description: + displayName: Description +views: + - type: table + name: New in v5 + order: + - title + - description + sort: + - property: title + direction: ASC +``` ## For Plugin Developers diff --git a/docs/plugins/Plugins.base b/docs/plugins/Plugins.base deleted file mode 100644 index 5d48d5d..0000000 --- a/docs/plugins/Plugins.base +++ /dev/null @@ -1,116 +0,0 @@ -filters: - and: - - file.ext == "md" - - file.inFolder("plugins") - - "!file.name.startsWith('index')" - - "!file.name.contains('Demo')" - - "!file.name.contains('Static')" - - "!file.name.contains('Assets')" - - "!file.name.contains('ComponentResources')" - - "!file.name.contains('NotFoundPage')" -formulas: - category: | - if(file.hasTag("plugin/transformer"), "Transformer", - if(file.hasTag("plugin/filter"), "Filter", - if(file.hasTag("plugin/pageType"), "Page Type", - if(file.hasTag("plugin/emitter"), "Emitter", - if(file.hasTag("plugin/component"), "Component", - "Other"))))) -properties: - title: - displayName: Plugin - repository: - displayName: Repository - enabled: - displayName: Enabled - required: - displayName: Required - description: - displayName: Description -views: - - type: table - name: All Plugins - groupBy: - property: formula.category - direction: ASC - order: - - title - - repository - - enabled - - required - - description - sort: - - property: formula.category - direction: ASC - - property: title - direction: ASC - - type: table - name: Transformers - filters: - and: - - file.hasTag("plugin/transformer") - order: - - title - - repository - - enabled - - required - - description - sort: - - property: title - direction: ASC - - type: table - name: Filters - filters: - and: - - file.hasTag("plugin/filter") - order: - - title - - repository - - enabled - - required - - description - sort: - - property: title - direction: ASC - - type: table - name: Page Types - filters: - and: - - file.hasTag("plugin/pageType") - order: - - title - - repository - - enabled - - required - - description - sort: - - property: title - direction: ASC - - type: table - name: Emitters - filters: - and: - - file.hasTag("plugin/emitter") - order: - - title - - repository - - enabled - - required - - description - sort: - - property: title - direction: ASC - - type: table - name: Components - filters: - and: - - file.hasTag("plugin/component") - order: - - title - - repository - - enabled - - required - - description - sort: - - property: title - direction: ASC diff --git a/docs/plugins/index.md b/docs/plugins/index.md index 758d266..8564a7f 100644 --- a/docs/plugins/index.md +++ b/docs/plugins/index.md @@ -22,7 +22,124 @@ Quartz plugins fall into several categories: ## First-party plugins -![[Plugins.base]] +```base +filters: + and: + - file.ext == "md" + - file.inFolder("plugins") + - "!file.name.startsWith('index')" + - "!file.name.contains('Demo')" + - "!file.name.contains('Static')" + - "!file.name.contains('Assets')" + - "!file.name.contains('ComponentResources')" + - "!file.name.contains('NotFoundPage')" +formulas: + category: | + if(file.hasTag("plugin/transformer"), "Transformer", + if(file.hasTag("plugin/filter"), "Filter", + if(file.hasTag("plugin/pageType"), "Page Type", + if(file.hasTag("plugin/emitter"), "Emitter", + if(file.hasTag("plugin/component"), "Component", + "Other"))))) +properties: + title: + displayName: Plugin + repository: + displayName: Repository + enabled: + displayName: Enabled + required: + displayName: Required + description: + displayName: Description +views: + - type: table + name: All Plugins + groupBy: + property: formula.category + direction: ASC + order: + - title + - repository + - enabled + - required + - description + sort: + - property: formula.category + direction: ASC + - property: title + direction: ASC + - type: table + name: Transformers + filters: + and: + - file.hasTag("plugin/transformer") + order: + - title + - repository + - enabled + - required + - description + sort: + - property: title + direction: ASC + - type: table + name: Filters + filters: + and: + - file.hasTag("plugin/filter") + order: + - title + - repository + - enabled + - required + - description + sort: + - property: title + direction: ASC + - type: table + name: Page Types + filters: + and: + - file.hasTag("plugin/pageType") + order: + - title + - repository + - enabled + - required + - description + sort: + - property: title + direction: ASC + - type: table + name: Emitters + filters: + and: + - file.hasTag("plugin/emitter") + order: + - title + - repository + - enabled + - required + - description + sort: + - property: title + direction: ASC + - type: table + name: Components + filters: + and: + - file.hasTag("plugin/component") + order: + - title + - repository + - enabled + - required + - description + sort: + - property: title + direction: ASC +``` > [!note] Multi-category plugins > Some plugins span multiple categories. **TableOfContents** is both a transformer and a component. **EncryptedPages** is a transformer, emitter, and component. They appear in each relevant category above.