docs: add repository, enabled, required frontmatter to all plugin docs

Added repository, enabled, and required fields to the frontmatter of
all 44 plugin documentation files. Updated Plugins.base to include
these columns, matching the information previously in the manual tables.
Also filtered out internal plugins (Assets, Static, ComponentResources,
NotFoundPage) from the base query.
This commit is contained in:
saberzero1
2026-05-24 19:46:42 +02:00
parent 38395a1bac
commit cce45e0718
45 changed files with 160 additions and 10 deletions

View File

@@ -3,6 +3,9 @@ title: AliasRedirects
tags:
- plugin/emitter
image: https://images.unsplash.com/photo-1601735479770-bb5de9dbe844
repository: "quartz-community/alias-redirects"
enabled: true
required: false
---
This plugin emits HTML redirect pages for aliases and permalinks defined in the frontmatter of content files.

View File

@@ -3,6 +3,9 @@ title: ArticleTitle
tags:
- plugin/component
image:
repository: "quartz-community/article-title"
enabled: true
required: false
---
This plugin renders the article title from the page's frontmatter as an `<h1>` heading at the top of the page content. It reads the `title` field from frontmatter (falling back to the filename if no title is set).

View File

@@ -3,6 +3,9 @@ title: Backlinks
tags:
- plugin/component
image:
repository: "quartz-community/backlinks"
enabled: true
required: false
---
Shows pages that link to the current page.

View File

@@ -5,6 +5,9 @@ tags:
- plugin/component
image:
new-in-v5: true
repository: "quartz-community/bases-page"
enabled: true
required: false
---
This plugin provides support for [Obsidian Bases](https://obsidian.md/changelog/2025-04-15-desktop-v1.8.0/) (`.base` files) in Quartz. It reads `.base` files from your vault, resolves matching notes based on the query definition, and renders them as interactive database-like views with support for tables, lists, cards, and maps. It uses the `default` [[layout#Page Frames|page frame]] (three-column layout with sidebars).

View File

@@ -3,6 +3,9 @@ title: Breadcrumbs
tags:
- plugin/component
image:
repository: "quartz-community/breadcrumbs"
enabled: true
required: false
---
Navigation breadcrumb trail.

View File

@@ -3,6 +3,9 @@ title: CNAME
tags:
- plugin/emitter
image:
repository: "quartz-community/cname"
enabled: true
required: false
---
This plugin emits a `CNAME` record that points your subdomain to the default domain of your site.

View File

@@ -4,6 +4,9 @@ tags:
- plugin/pageType
image: "#7852ee"
new-in-v5: true
repository: "quartz-community/canvas-page"
enabled: true
required: false
---
This plugin is a page type plugin that renders [JSON Canvas](https://jsoncanvas.org) (`.canvas`) files as interactive, pannable and zoomable canvas pages. It uses a custom `"canvas"` [[layout#Page Frames|page frame]] that provides a fullscreen, always-on canvas experience with a togglable left sidebar for navigation. It supports the full [JSON Canvas 1.0 spec](https://jsoncanvas.org/spec/1.0/), including text nodes with Markdown rendering, file nodes that link to other pages in your vault, link nodes for external URLs, and group nodes for visual organization. Edges between nodes are rendered as SVG paths with optional labels, arrow markers, and colors.

View File

@@ -3,6 +3,9 @@ title: Citations
tags:
- plugin/transformer
image: https://images.unsplash.com/photo-1582079133805-43655f026448
repository: "quartz-community/citations"
enabled: false
required: false
---
This plugin adds Citation support to Quartz.

View File

@@ -3,6 +3,9 @@ title: Comments
tags:
- plugin/component
image: "[[giscus-results.png]]"
repository: "quartz-community/comments"
enabled: false
required: false
---
Comment system (giscus, utterances, etc.).

View File

@@ -3,6 +3,9 @@ title: ContentIndex
tags:
- plugin/emitter
image:
repository: "quartz-community/content-index"
enabled: true
required: false
---
This plugin emits both RSS and an XML sitemap for your site. The [[RSS Feed]] allows users to subscribe to content on your site and the sitemap allows search engines to better index your site. The plugin also emits a `contentIndex.json` file which is used by dynamic frontend components like search and graph.

View File

@@ -3,6 +3,9 @@ title: ContentMeta
tags:
- plugin/component
image:
repository: "quartz-community/content-meta"
enabled: true
required: false
---
This plugin displays content metadata below the article title, such as the creation date and estimated reading time.

View File

@@ -3,6 +3,9 @@ title: ContentPage
tags:
- plugin/pageType
image:
repository: "quartz-community/content-page"
enabled: true
required: false
---
This plugin is a page type plugin for the Quartz framework. It generates the HTML pages for each piece of Markdown content. It emits the full-page [[layout]], including headers, footers, and body content, among others. It uses the `default` [[layout#Page Frames|page frame]] (three-column layout with sidebars). It is now configured in the `pageTypes` section of `quartz.config.yaml`.

View File

@@ -3,6 +3,9 @@ title: CrawlLinks
tags:
- plugin/transformer
image:
repository: "quartz-community/crawl-links"
enabled: true
required: true
---
This plugin parses links and processes them to point to the right places. It is also needed for embedded links (like images). See [[Obsidian compatibility]] for more information.

View File

@@ -3,6 +3,9 @@ title: CreatedModifiedDate
tags:
- plugin/transformer
image:
repository: "quartz-community/created-modified-date"
enabled: true
required: false
---
This plugin determines the created, modified, and published dates for a document using three potential data sources: frontmatter metadata, Git history, and the filesystem. See [[authoring content#Syntax]] for more information.

View File

@@ -3,6 +3,9 @@ title: Custom OG Images
tags:
- feature/emitter
image: "[[social-image-preview-dark.png]]"
repository: "quartz-community/og-image"
enabled: true
required: false
---
The Custom OG Images emitter plugin generates social media preview images for your pages. It uses [satori](https://github.com/vercel/satori) to convert HTML/CSS into images, allowing you to create beautiful and consistent social media preview cards for your content.

View File

@@ -3,6 +3,9 @@ title: Darkmode
tags:
- plugin/component
image: "#0052cc"
repository: "quartz-community/darkmode"
enabled: true
required: false
---
Dark mode toggle.

View File

@@ -3,6 +3,9 @@ title: Description
tags:
- plugin/transformer
image:
repository: "quartz-community/description"
enabled: true
required: false
---
This plugin generates descriptions that are used as metadata for the HTML `head`, the [[RSS Feed]] and in [[folder and tag listings]] if there is no main body content, the description is used as the text between the title and the listing.

View File

@@ -5,6 +5,9 @@ tags:
- plugin/emitter
image: "#FF1493"
new-in-v5: true
repository: "quartz-community/encrypted-pages"
enabled: true
required: false
---
Password-protected encrypted pages. Encrypts page content at build time using AES-256-GCM and decrypts client-side with the Web Crypto API. Passwords are set per-page via frontmatter. A companion emitter writes an encrypted shadow content index so unlisted encrypted pages can be dynamically revealed in graph, explorer, and search after a successful decryption — without ever leaking their metadata to visitors who do not hold the password.

View File

@@ -3,6 +3,9 @@ title: ExplicitPublish
tags:
- plugin/filter
image:
repository: "quartz-community/explicit-publish"
enabled: false
required: false
---
This plugin filters content based on an explicit `publish` flag in the frontmatter, allowing only content that is explicitly marked for publication to pass through. It's the opt-in version of [[RemoveDrafts]]. See [[private pages]] for more information.

View File

@@ -3,6 +3,9 @@ title: Explorer
tags:
- plugin/component
image:
repository: "quartz-community/explorer"
enabled: true
required: false
---
File tree explorer sidebar.

View File

@@ -3,6 +3,9 @@ title: Favicon
tags:
- plugin/emitter
image:
repository: "quartz-community/favicon"
enabled: true
required: false
---
This plugin emits a `favicon.ico` into the `public` folder. It creates the favicon from `icon.png` located in the `quartz/static` folder.

View File

@@ -3,6 +3,9 @@ title: FolderPage
tags:
- plugin/pageType
image:
repository: "quartz-community/folder-page"
enabled: true
required: false
---
This plugin is a page type plugin that generates index pages for folders, creating a listing page for each folder that contains multiple content files. It uses the `default` [[layout#Page Frames|page frame]] (three-column layout with sidebars). See [[folder and tag listings]] for more information.

View File

@@ -3,6 +3,9 @@ title: Footer
tags:
- plugin/component
image:
repository: "quartz-community/footer"
enabled: true
required: false
---
This plugin renders a footer at the bottom of the page with a "Created with Quartz" message and a set of configurable links.

View File

@@ -10,6 +10,9 @@ tags:
publish: true
enableToc: true
image:
repository: "quartz-community/note-properties"
enabled: true
required: true
---
This plugin parses the frontmatter of the page using the [gray-matter](https://github.com/jonschlinkert/gray-matter) library and optionally displays selected properties in a collapsible panel. See [[authoring content#Syntax]], [[Obsidian compatibility]] and [[OxHugo compatibility]] for more information.

View File

@@ -3,6 +3,9 @@ title: GitHubFlavoredMarkdown
tags:
- plugin/transformer
image:
repository: "quartz-community/github-flavored-markdown"
enabled: true
required: false
---
This plugin enhances Markdown processing to support GitHub Flavored Markdown (GFM) which adds features like autolink literals, footnotes, strikethrough, tables and tasklists.

View File

@@ -3,6 +3,9 @@ title: Graph
tags:
- plugin/component
image:
repository: "quartz-community/graph"
enabled: true
required: false
---
Interactive graph visualization.

View File

@@ -3,6 +3,9 @@ title: HardLineBreaks
tags:
- plugin/transformer
image: "#ff8000"
repository: "quartz-community/hard-line-breaks"
enabled: false
required: false
---
This plugin automatically converts single line breaks in Markdown text into hard line breaks in the HTML output. This plugin is not enabled by default as this doesn't follow the semantics of actual Markdown but you may enable it if you'd like parity with [[Obsidian compatibility|Obsidian]].

View File

@@ -3,6 +3,9 @@ title: Latex
tags:
- plugin/transformer
image:
repository: "quartz-community/latex"
enabled: true
required: false
---
This plugin adds LaTeX support to Quartz. See [[features/Latex|Latex]] for more information.

View File

@@ -4,6 +4,9 @@ tags:
- plugin/component
image:
new-in-v5: true
repository: "quartz-community/note-properties"
enabled: true
required: true
---
The NoteProperties plugin is documented under [[Frontmatter]].

View File

@@ -3,6 +3,9 @@ title: ObsidianFlavoredMarkdown
tags:
- plugin/transformer
image:
repository: "quartz-community/obsidian-flavored-markdown"
enabled: true
required: false
---
This plugin provides support for [[Obsidian compatibility]].

View File

@@ -3,6 +3,9 @@ title: OxHugoFlavoredMarkdown
tags:
- plugin/transformer
image:
repository: "quartz-community/ox-hugo"
enabled: false
required: false
---
This plugin provides support for [ox-hugo](https://github.com/kaushalmodi/ox-hugo) compatibility. See [[OxHugo compatibility]] for more information.

View File

@@ -3,6 +3,9 @@ title: PageTitle
tags:
- plugin/component
image:
repository: "quartz-community/page-title"
enabled: true
required: false
---
This plugin renders the site-wide page title (configured via the `pageTitle` field in [[configuration]]) as a clickable link to the home page. It typically appears in the left sidebar.

View File

@@ -4,6 +4,10 @@ filters:
- 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",
@@ -12,18 +16,15 @@ formulas:
if(file.hasTag("plugin/emitter"), "Emitter",
if(file.hasTag("plugin/component"), "Component",
"Other")))))
source: |
if(file.hasTag("plugin/transformer"), "community",
if(file.hasTag("plugin/filter"), "community",
if(file.hasTag("plugin/pageType"), "community",
if(file.hasTag("plugin/emitter"), "community",
if(file.hasTag("plugin/component"), "community",
"internal")))))
properties:
title:
displayName: Plugin
formula.category:
displayName: Type
repository:
displayName: Repository
enabled:
displayName: Enabled
required:
displayName: Required
description:
displayName: Description
views:
@@ -34,7 +35,9 @@ views:
direction: ASC
order:
- title
- formula.category
- repository
- enabled
- required
- description
sort:
- property: formula.category
@@ -48,6 +51,9 @@ views:
- file.hasTag("plugin/transformer")
order:
- title
- repository
- enabled
- required
- description
sort:
- property: title
@@ -59,6 +65,9 @@ views:
- file.hasTag("plugin/filter")
order:
- title
- repository
- enabled
- required
- description
sort:
- property: title
@@ -70,6 +79,9 @@ views:
- file.hasTag("plugin/pageType")
order:
- title
- repository
- enabled
- required
- description
sort:
- property: title
@@ -81,6 +93,9 @@ views:
- file.hasTag("plugin/emitter")
order:
- title
- repository
- enabled
- required
- description
sort:
- property: title
@@ -92,6 +107,9 @@ views:
- file.hasTag("plugin/component")
order:
- title
- repository
- enabled
- required
- description
sort:
- property: title

View File

@@ -4,6 +4,9 @@ tags:
- plugin/component
image:
new-in-v5: true
repository: "quartz-community/reader-mode"
enabled: true
required: false
---
Distraction-free reading mode.

View File

@@ -3,6 +3,9 @@ title: RecentNotes
tags:
- plugin/component
image:
repository: "quartz-community/recent-notes"
enabled: false
required: false
---
Shows recently modified notes.

View File

@@ -3,6 +3,9 @@ title: RemoveDrafts
tags:
- plugin/filter
image:
repository: "quartz-community/remove-draft"
enabled: true
required: false
---
This plugin filters out content from your vault, so that only finalized content is made available. This prevents [[private pages]] from being published. By default, it filters out all pages with `draft: true` in the frontmatter and leaves all other pages intact.

View File

@@ -3,6 +3,9 @@ title: RoamFlavoredMarkdown
tags:
- plugin/transformer
image:
repository: "quartz-community/roam"
enabled: false
required: false
---
This plugin provides support for [Roam Research](https://roamresearch.com) compatibility. See [[Roam Research compatibility]] for more information.

View File

@@ -3,6 +3,9 @@ title: Search
tags:
- plugin/component
image: https://images.unsplash.com/photo-1516382799247-87df95d790b7
repository: "quartz-community/search"
enabled: true
required: false
---
Full-text search functionality.

View File

@@ -4,6 +4,9 @@ tags:
- plugin/component
image:
new-in-v5: true
repository: "quartz-community/spacer"
enabled: true
required: false
---
This plugin renders a flexible spacer element that pushes adjacent components apart within a layout group. It uses CSS `flex: 2 1 auto` to fill available space, making it useful for spacing out items in toolbars or sidebars (for example, separating the search bar from the darkmode toggle in the left sidebar toolbar).

View File

@@ -4,6 +4,9 @@ tags:
- plugin/component
image:
new-in-v5: true
repository: "quartz-community/stacked-pages"
enabled: true
required: false
---
Andy Matuschak-style stacked pages (sliding panes). Clicking internal links opens pages side by side in a horizontal stack, allowing you to trace your path through your notes. Each pane shows a full page and can be individually scrolled or closed.

View File

@@ -3,6 +3,9 @@ title: SyntaxHighlighting
tags:
- plugin/transformer
image: https://images.unsplash.com/photo-1580569214296-5cf2bffc5ccd
repository: "quartz-community/syntax-highlighting"
enabled: true
required: false
---
This plugin is used to add syntax highlighting to code blocks in Quartz. See [[syntax highlighting]] for more information.

View File

@@ -4,6 +4,9 @@ tags:
- plugin/transformer
- plugin/component
image: https://images.unsplash.com/photo-1768527338896-3765921e992d
repository: "quartz-community/table-of-contents"
enabled: true
required: false
---
This plugin generates a table of contents (TOC) for Markdown documents. See [[table of contents]] for more information.

View File

@@ -3,6 +3,9 @@ title: TagList
tags:
- plugin/component
image:
repository: "quartz-community/tag-list"
enabled: false
required: false
---
This plugin renders the page's tags as a list of clickable links. Each tag links to its corresponding [[TagPage|tag page]], making it easy for readers to browse related content by topic.

View File

@@ -3,6 +3,9 @@ title: TagPage
tags:
- plugin/pageType
image:
repository: "quartz-community/tag-page"
enabled: true
required: false
---
This plugin is a page type plugin that emits dedicated pages for each tag used in the content. It uses the `default` [[layout#Page Frames|page frame]] (three-column layout with sidebars). See [[folder and tag listings]] for more information.

View File

@@ -4,6 +4,9 @@ tags:
- plugin/transformer
image:
new-in-v5: true
repository: "quartz-community/unlisted-pages"
enabled: true
required: false
---
Zero-config transformer that makes `unlisted: true` in a page's frontmatter a first-class way to opt out of every listing surface on your site. The page is still emitted as HTML and remains accessible by direct URL, but is absent from `contentIndex.json`, RSS, sitemap, graph, explorer, search, backlinks, recent notes, folder listings, and tag listings.