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 useExternalPlugin.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
| Plugin | Repository | Enabled | Required | Description |
|---|---|---|---|---|
| Category Component17 | ||||
| ArticleTitle | quartz-community/article-title | Renders the article title as an h1 heading. | ||
| Backlinks | quartz-community/backlinks | Shows pages that link to the current page. | ||
| Breadcrumbs | quartz-community/breadcrumbs | Breadcrumb navigation trail. | ||
| Comments | quartz-community/comments | Comment system integration (Giscus, Utterances, etc.). | ||
| ContentMeta | quartz-community/content-meta | Displays creation date and reading time. | ||
| Darkmode | quartz-community/darkmode | Toggle between light and dark themes. | ||
| Explorer | quartz-community/explorer | File tree explorer sidebar. | ||
| Footer | quartz-community/footer | Page footer with configurable links. | ||
| Graph | quartz-community/graph | Interactive link graph visualization. | ||
| NoteProperties | quartz-community/note-properties | Displays frontmatter properties in a collapsible panel. | ||
| PageTitle | quartz-community/page-title | Renders the site title as a home link. | ||
| ReaderMode | quartz-community/reader-mode | Distraction-free reading mode toggle. | ||
| RecentNotes | quartz-community/recent-notes | Displays a list of recently modified notes. | ||
| Search | quartz-community/search | Full-text search with tag filtering and keyboard navigation. | ||
| Spacer | quartz-community/spacer | Flexible spacer for layout groups. | ||
| StackedPages | quartz-community/stacked-pages | Andy Matuschak-style stacked sliding panes. | ||
| TagList | quartz-community/tag-list | Renders tags as clickable links. | ||
| Category Emitter4 | ||||
| AliasRedirects | quartz-community/alias-redirects | Generates redirect pages from frontmatter aliases. | ||
| CNAME | quartz-community/cname | Emits a CNAME file for custom domain deployment. | ||
| ContentIndex | quartz-community/content-index | Generates sitemap, RSS feed, and content index. | ||
| Favicon | quartz-community/favicon | Emits the site favicon. | ||
| Category Filter2 | ||||
| ExplicitPublish | quartz-community/explicit-publish | Only publishes pages explicitly marked with publish: true. | ||
| RemoveDrafts | quartz-community/remove-draft | Filters out pages marked as drafts. | ||
| Category Other1 | ||||
| Custom OG Images | quartz-community/og-image | Generates Open Graph social preview images. | ||
| Category Page Type5 | ||||
| BasesPage | quartz-community/bases-page | Renders Obsidian Bases files as database-style views. | ||
| CanvasPage | quartz-community/canvas-page | Renders JSON Canvas files as interactive, pannable pages. | ||
| ContentPage | quartz-community/content-page | Generates HTML pages for Markdown content. | ||
| FolderPage | quartz-community/folder-page | Generates listing pages for folders. | ||
| TagPage | quartz-community/tag-page | Generates listing pages for tags. | ||
| Category Transformer15 | ||||
| Citations | quartz-community/citations | Academic citation and bibliography support via BibTeX. | ||
| CrawlLinks | quartz-community/crawl-links | Parses and resolves internal links. Removing it is not recommended. | ||
| CreatedModifiedDate | quartz-community/created-modified-date | Determines creation and modification dates from frontmatter, git, or filesystem. | ||
| Description | quartz-community/description | Generates page descriptions for metadata and previews. | ||
| EncryptedPages | quartz-community/encrypted-pages | Password-protected encrypted pages with shadow content index. | ||
| Frontmatter | quartz-community/note-properties | Parses frontmatter and displays note properties in a collapsible panel. | ||
| GitHubFlavoredMarkdown | quartz-community/github-flavored-markdown | GitHub Flavored Markdown support (tables, task lists, footnotes, strikethrough). | ||
| HardLineBreaks | quartz-community/hard-line-breaks | Treats single newlines as hard line breaks. | ||
| Latex | quartz-community/latex | Renders LaTeX math expressions via KaTeX or Typst. | ||
| ObsidianFlavoredMarkdown | quartz-community/obsidian-flavored-markdown | Obsidian-specific Markdown extensions (wikilinks, callouts, highlights, tags, embeds). | ||
| OxHugoFlavoredMarkdown | quartz-community/ox-hugo | Compatibility for ox-hugo exported Org-mode files. | ||
| RoamFlavoredMarkdown | quartz-community/roam | Compatibility for Roam Research export format. | ||
| SyntaxHighlighting | quartz-community/syntax-highlighting | Syntax highlighting for code blocks. | ||
| TableOfContents | quartz-community/table-of-contents | Generates and renders a table of contents from headings. | ||
| UnlistedPages | quartz-community/unlisted-pages | Hides pages from navigation and indexes while still publishing them. | ||
| Plugin | Repository | Enabled | Required | Description |
|---|---|---|---|---|
| Citations | quartz-community/citations | Academic citation and bibliography support via BibTeX. | ||
| CrawlLinks | quartz-community/crawl-links | Parses and resolves internal links. Removing it is not recommended. | ||
| CreatedModifiedDate | quartz-community/created-modified-date | Determines creation and modification dates from frontmatter, git, or filesystem. | ||
| Description | quartz-community/description | Generates page descriptions for metadata and previews. | ||
| EncryptedPages | quartz-community/encrypted-pages | Password-protected encrypted pages with shadow content index. | ||
| Frontmatter | quartz-community/note-properties | Parses frontmatter and displays note properties in a collapsible panel. | ||
| GitHubFlavoredMarkdown | quartz-community/github-flavored-markdown | GitHub Flavored Markdown support (tables, task lists, footnotes, strikethrough). | ||
| HardLineBreaks | quartz-community/hard-line-breaks | Treats single newlines as hard line breaks. | ||
| Latex | quartz-community/latex | Renders LaTeX math expressions via KaTeX or Typst. | ||
| ObsidianFlavoredMarkdown | quartz-community/obsidian-flavored-markdown | Obsidian-specific Markdown extensions (wikilinks, callouts, highlights, tags, embeds). | ||
| OxHugoFlavoredMarkdown | quartz-community/ox-hugo | Compatibility for ox-hugo exported Org-mode files. | ||
| RoamFlavoredMarkdown | quartz-community/roam | Compatibility for Roam Research export format. | ||
| SyntaxHighlighting | quartz-community/syntax-highlighting | Syntax highlighting for code blocks. | ||
| TableOfContents | quartz-community/table-of-contents | Generates and renders a table of contents from headings. | ||
| UnlistedPages | quartz-community/unlisted-pages | Hides pages from navigation and indexes while still publishing them. |
| Plugin | Repository | Enabled | Required | Description |
|---|---|---|---|---|
| ExplicitPublish | quartz-community/explicit-publish | Only publishes pages explicitly marked with publish: true. | ||
| RemoveDrafts | quartz-community/remove-draft | Filters out pages marked as drafts. |
| Plugin | Repository | Enabled | Required | Description |
|---|---|---|---|---|
| BasesPage | quartz-community/bases-page | Renders Obsidian Bases files as database-style views. | ||
| CanvasPage | quartz-community/canvas-page | Renders JSON Canvas files as interactive, pannable pages. | ||
| ContentPage | quartz-community/content-page | Generates HTML pages for Markdown content. | ||
| FolderPage | quartz-community/folder-page | Generates listing pages for folders. | ||
| TagPage | quartz-community/tag-page | Generates listing pages for tags. |
| Plugin | Repository | Enabled | Required | Description |
|---|---|---|---|---|
| AliasRedirects | quartz-community/alias-redirects | Generates redirect pages from frontmatter aliases. | ||
| CNAME | quartz-community/cname | Emits a CNAME file for custom domain deployment. | ||
| ContentIndex | quartz-community/content-index | Generates sitemap, RSS feed, and content index. | ||
| EncryptedPages | quartz-community/encrypted-pages | Password-protected encrypted pages with shadow content index. | ||
| Favicon | quartz-community/favicon | Emits the site favicon. |
| Plugin | Repository | Enabled | Required | Description |
|---|---|---|---|---|
| ArticleTitle | quartz-community/article-title | Renders the article title as an h1 heading. | ||
| Backlinks | quartz-community/backlinks | Shows pages that link to the current page. | ||
| BasesPage | quartz-community/bases-page | Renders Obsidian Bases files as database-style views. | ||
| Breadcrumbs | quartz-community/breadcrumbs | Breadcrumb navigation trail. | ||
| Comments | quartz-community/comments | Comment system integration (Giscus, Utterances, etc.). | ||
| ContentMeta | quartz-community/content-meta | Displays creation date and reading time. | ||
| Darkmode | quartz-community/darkmode | Toggle between light and dark themes. | ||
| Explorer | quartz-community/explorer | File tree explorer sidebar. | ||
| Footer | quartz-community/footer | Page footer with configurable links. | ||
| Frontmatter | quartz-community/note-properties | Parses frontmatter and displays note properties in a collapsible panel. | ||
| Graph | quartz-community/graph | Interactive link graph visualization. | ||
| NoteProperties | quartz-community/note-properties | Displays frontmatter properties in a collapsible panel. | ||
| PageTitle | quartz-community/page-title | Renders the site title as a home link. | ||
| ReaderMode | quartz-community/reader-mode | Distraction-free reading mode toggle. | ||
| RecentNotes | quartz-community/recent-notes | Displays a list of recently modified notes. | ||
| Search | quartz-community/search | Full-text search with tag filtering and keyboard navigation. | ||
| Spacer | quartz-community/spacer | Flexible spacer for layout groups. | ||
| StackedPages | quartz-community/stacked-pages | Andy Matuschak-style stacked sliding panes. | ||
| TableOfContents | quartz-community/table-of-contents | Generates and renders a table of contents from headings. | ||
| TagList | quartz-community/tag-list | Renders tags as clickable links. |
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.