Quartz 5

Plugins

2 min read

Quartz’s functionality is provided by a collection of first-party community plugins. Each plugin can be enabled, disabled, and configured via quartz.config.yaml. See Configuration for details on how to manage plugins.

Internal vs Community Plugins

Quartz has two kinds of plugins:

  • Community plugins are standalone repositories under quartz-community. In TS overrides, they use ExternalPlugin.X() (imported from .quartz/plugins).
  • Internal plugins are built into Quartz core (Assets, Static, ComponentResources, NotFoundPage). In TS overrides, they use Plugin.X() (imported from ./quartz/plugins).

Plugin types

Quartz plugins fall into several categories:

  • Transformers process content during the build, e.g. parsing frontmatter, highlighting syntax, or resolving links.
  • Filters decide which content files to include or exclude from the output.
  • Page Types generate HTML pages — one per content file, folder, tag, canvas, or bases view.
  • Components render UI elements in the page layout (sidebars, headers, footers, etc.).

First-party plugins

Transformers

PluginRepositoryEnabledRequiredDescription
Note Propertiesquartz-community/note-properties✅✅Parses frontmatter and displays note properties.
CreatedModifiedDatequartz-community/created-modified-date✅❌Determines creation and modification dates.
SyntaxHighlightingquartz-community/syntax-highlighting✅❌Syntax highlighting for code blocks.
ObsidianFlavoredMarkdownquartz-community/obsidian-flavored-markdown✅❌Obsidian-specific Markdown extensions.
GitHubFlavoredMarkdownquartz-community/github-flavored-markdown✅❌GitHub Flavored Markdown support.
TableOfContentsquartz-community/table-of-contents✅❌Generates table of contents data from headings.
CrawlLinksquartz-community/crawl-links✅⚠️Parses and resolves links. Removing it is not recommended.
Descriptionquartz-community/description✅❌Generates page descriptions for metadata.
Latexquartz-community/latex✅❌Renders LaTeX math expressions.
Citationsquartz-community/citations❌❌Academic citation support via BibTeX.
HardLineBreaksquartz-community/hard-line-breaks❌❌Treats single newlines as hard line breaks.
OxHugoFlavoredMarkdownquartz-community/ox-hugo❌❌ox-hugo Markdown compatibility.
RoamFlavoredMarkdownquartz-community/roam❌❌Roam Research Markdown compatibility.

Filters

PluginRepositoryEnabledRequiredDescription
RemoveDraftsquartz-community/remove-draft✅❌Filters out pages marked as drafts.
ExplicitPublishquartz-community/explicit-publish❌❌Only publishes pages explicitly marked.

Page Types

PluginRepositoryEnabledRequiredDescription
ContentPagequartz-community/content-page✅❌Generates HTML pages for Markdown content.
FolderPagequartz-community/folder-page✅❌Generates folder listing pages.
TagPagequartz-community/tag-page✅❌Generates tag listing pages.
CanvasPagequartz-community/canvas-page✅❌Renders JSON Canvas files as interactive pages.
BasesPagequartz-community/bases-page✅❌Renders Obsidian Bases files as database views.

Emitters

PluginRepositoryEnabledRequiredDescription
AliasRedirectsquartz-community/alias-redirects✅❌Generates redirect pages for aliases.
ContentIndexquartz-community/content-index✅❌Generates sitemap, RSS feed, and content index.
Faviconquartz-community/favicon✅❌Emits the site favicon.
OG Imagequartz-community/og-image✅❌Generates Open Graph social preview images.
CNAMEquartz-community/cname✅❌Emits a CNAME file for custom domains.

Components

PluginRepositoryEnabledRequiredDescription
ArticleTitlequartz-community/article-title✅❌Renders the article title as an h1 heading.
ContentMetaquartz-community/content-meta✅❌Displays creation date and reading time.
TagListquartz-community/tag-list❌❌Renders tags as clickable links.
PageTitlequartz-community/page-title✅❌Renders the site title as a home link.
Darkmodequartz-community/darkmode✅❌Toggle between light and dark themes.
Reader Modequartz-community/reader-mode✅❌Distraction-free reading mode toggle.
Explorerquartz-community/explorer✅❌File tree explorer sidebar.
Graph Viewquartz-community/graph✅❌Interactive link graph visualization.
Searchquartz-community/search✅❌Full-text search functionality.
Backlinksquartz-community/backlinks✅❌Shows pages that link to the current page.
Breadcrumbsquartz-community/breadcrumbs✅❌Breadcrumb navigation trail.
Commentsquartz-community/comments❌❌Comment system integration (Giscus, etc.).
Footerquartz-community/footer✅❌Page footer with configurable links.
Recent Notesquartz-community/recent-notes❌❌Displays a list of recently modified notes.
Spacerquartz-community/spacer✅❌Flexible spacer for layout groups.
EncryptedPagesquartz-community/encrypted-pages✅❌Password-protected encrypted pages.
StackedPagesquartz-community/stacked-pages✅❌Andy Matuschak-style stacked sliding panes.

48 items under this folder.