zaine/quartz
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: updated links

Browse Source
This commit is contained in:
saberzero1
2026-04-17 03:25:16 +02:00
parent c32d11cb8b
commit 6c3b94e474
21 changed files with 65 additions and 65 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
docs/cli/index.md
View File

@@ -19,13 +19,13 @@ You can run the CLI using `npx quartz`.
## Commands ## Commands
- [[cli/create|create]]: Initialize a new Quartz project with a choice of templates (default, obsidian, ttrpg, blog) and base URL configuration. - [[create|create]]: Initialize a new Quartz project with a choice of templates (default, obsidian, ttrpg, blog) and base URL configuration.
- [[cli/build|build]]: Build your Quartz site into static HTML. Includes a development server. - [[build|build]]: Build your Quartz site into static HTML. Includes a development server.
- [[cli/sync|sync]]: Push and pull changes between your local machine and GitHub. - [[sync|sync]]: Push and pull changes between your local machine and GitHub.
- [[cli/upgrade|upgrade]]: Upgrade the Quartz framework to the latest version. Also available as `npx quartz update`. - [[upgrade|upgrade]]: Upgrade the Quartz framework to the latest version. Also available as `npx quartz update`.
- [[cli/restore|restore]]: Recover your content folder from the local cache. - [[restore|restore]]: Recover your content folder from the local cache.
- [[cli/plugin|plugin]]: Install, add, remove, prune, and configure plugins. Use `plugin install` with flags for lockfile/config sync, updates, and checks. - [[cli/plugin|plugin]]: Install, add, remove, prune, and configure plugins. Use `plugin install` with flags for lockfile/config sync, updates, and checks.
- [[cli/tui|tui]]: Use a terminal interface to manage plugins and layout. - [[tui|tui]]: Use a terminal interface to manage plugins and layout.
## Global Flags ## Global Flags
@@ -37,7 +37,7 @@ These flags are accepted by every Quartz command:
| `--verbose` | `-v` | Enable detailed logging for debugging | `false` | | `--verbose` | `-v` | Enable detailed logging for debugging | `false` |
| `--concurrency` | `-c` | Max parallel workers for operations that run in parallel (e.g. `build`, `plugin install`, `plugin add`) | CPU core count | | `--concurrency` | `-c` | Max parallel workers for operations that run in parallel (e.g. `build`, `plugin install`, `plugin add`) | CPU core count |
Commands that don't perform parallel work accept `-c` as a no-op, so it's always safe to pass. See [[cli/build#Performance Tuning|build]] and [[cli/plugin#Installing on low-end hardware|plugin]] for practical examples. Commands that don't perform parallel work accept `-c` as a no-op, so it's always safe to pass. See [[build#Performance Tuning|build]] and [[cli/plugin#Installing on low-end hardware|plugin]] for practical examples.
## Help and Versioning ## Help and Versioning

2
docs/cli/plugin.md
View File

@@ -270,4 +270,4 @@ Running the plugin command without any subcommand shows a status dashboard of al
npx quartz plugin npx quartz plugin
``` ```
This displays each plugin with its source, commit, enabled/disabled status, and checks for available updates in parallel. For the full interactive management interface, use [[cli/tui|npx quartz tui]] instead. This displays each plugin with its source, commit, enabled/disabled status, and checks for available updates in parallel. For the full interactive management interface, use [[tui|npx quartz tui]] instead.

2
docs/cli/sync.md
View File

@@ -71,4 +71,4 @@ If you have a very large number of changes, Git might occasionally fail due to b
Quartz uses `git pull --rebase --autostash` internally. This means if you have unstaged changes when you run `sync`, Quartz will temporarily hide them, pull the remote changes, and then bring your changes back. If a conflict occurs during this process, you will need to resolve it manually using standard Git tools. Quartz uses `git pull --rebase --autostash` internally. This means if you have unstaged changes when you run `sync`, Quartz will temporarily hide them, pull the remote changes, and then bring your changes back. If a conflict occurs during this process, you will need to resolve it manually using standard Git tools.
For more information on initial setup, see [[getting-started/installation]]. For more information on initial setup, see [[installation]].

6
docs/cli/upgrade.md
View File

@@ -35,7 +35,7 @@ For other files, if a conflict occurs:
## Recovery ## Recovery
If an upgrade goes wrong or leaves your project in an unusable state, you can use the [[cli/restore|restore]] command to recover your content from the local cache. If an upgrade goes wrong or leaves your project in an unusable state, you can use the [[restore|restore]] command to recover your content from the local cache.
## Flags ## Flags
@@ -44,5 +44,5 @@ The `upgrade` command supports the standard [[cli/index|common flags]] (`--direc
## See Also ## See Also
- [[cli/plugin|quartz plugin install --latest]] — update installed plugins - [[cli/plugin|quartz plugin install --latest]] — update installed plugins
- [[getting-started/upgrading|Upgrading Quartz]] — detailed upgrading guide - [[upgrading|Upgrading Quartz]] — detailed upgrading guide
- [[cli/restore|quartz restore]] — recover content from cache - [[restore|quartz restore]] — recover content from cache

2
docs/configuration.md
View File

@@ -42,7 +42,7 @@ This part of the configuration concerns anything that can affect the whole site.
- `{ provider: 'rybbit', siteId: 'my-rybbit-id' }` (managed) or `{ provider: 'rybbit', siteId: 'my-rybbit-id', host: 'my-rybbit-domain.com' }` (self-hosted) use [Rybbit](https://rybbit.com); - `{ provider: 'rybbit', siteId: 'my-rybbit-id' }` (managed) or `{ provider: 'rybbit', siteId: 'my-rybbit-id', host: 'my-rybbit-domain.com' }` (self-hosted) use [Rybbit](https://rybbit.com);
- `locale`: used for [[i18n]] and date formatting - `locale`: used for [[i18n]] and date formatting
- `baseUrl`: this is used for sitemaps and RSS feeds that require an absolute URL to know where the canonical 'home' of your site lives. This is normally the deployed URL of your site (e.g. `quartz.jzhao.xyz` for this site). Do not include the protocol (i.e. `https://`) or any leading or trailing slashes. - `baseUrl`: this is used for sitemaps and RSS feeds that require an absolute URL to know where the canonical 'home' of your site lives. This is normally the deployed URL of your site (e.g. `quartz.jzhao.xyz` for this site). Do not include the protocol (i.e. `https://`) or any leading or trailing slashes.
- You will be prompted to set this during [[cli/create|`npx quartz create`]]. The CLI automatically strips any `https://` or `http://` protocol prefixes and trailing slashes for you. - You will be prompted to set this during [[create|`npx quartz create`]]. The CLI automatically strips any `https://` or `http://` protocol prefixes and trailing slashes for you.
- This should also include the subpath if you are [[hosting]] on GitHub pages without a custom domain. For example, if my repository is `jackyzha0/quartz`, GitHub pages would deploy to `https://jackyzha0.github.io/quartz` and the `baseUrl` would be `jackyzha0.github.io/quartz`. - This should also include the subpath if you are [[hosting]] on GitHub pages without a custom domain. For example, if my repository is `jackyzha0/quartz`, GitHub pages would deploy to `https://jackyzha0.github.io/quartz` and the `baseUrl` would be `jackyzha0.github.io/quartz`.
- Note that Quartz 5 will avoid using this as much as possible and use relative URLs whenever it can to make sure your site works no matter _where_ you end up actually deploying it. - Note that Quartz 5 will avoid using this as much as possible and use relative URLs whenever it can to make sure your site works no matter _where_ you end up actually deploying it.
- `ignorePatterns`: a list of [glob](<https://en.wikipedia.org/wiki/Glob_(programming)>) patterns that Quartz should ignore and not search through when looking for files inside the `content` folder. See [[private pages]] for more details. - `ignorePatterns`: a list of [glob](<https://en.wikipedia.org/wiki/Glob_(programming)>) patterns that Quartz should ignore and not search through when looking for files inside the `content` folder. See [[private pages]] for more details.

16
docs/features/index.md
View File

@@ -9,12 +9,12 @@ Quartz comes with a wide variety of features out of the box. Most features are p
- [[Obsidian compatibility]] — Full support for Obsidian-flavored Markdown - [[Obsidian compatibility]] — Full support for Obsidian-flavored Markdown
- [[wikilinks]] — Link between notes using `[[wikilinks]]` syntax - [[wikilinks]] — Link between notes using `[[wikilinks]]` syntax
- [[callouts]] — Obsidian-style callout blocks - [[callouts]] — Obsidian-style callout blocks
- [[Latex]] — LaTeX math rendering - [[features/Latex|Latex]] — LaTeX math rendering
- [[Mermaid diagrams]] — Diagram support via Mermaid - [[Mermaid diagrams]] — Diagram support via Mermaid
- [[syntax highlighting]] — Code block highlighting with themes - [[syntax highlighting|Syntax highlighting]] — Code block highlighting with themes
- [[OxHugo compatibility]] — Support for ox-hugo Markdown - [[OxHugo compatibility]] — Support for ox-hugo Markdown
- [[Roam Research compatibility]] — Support for Roam Research syntax - [[Roam Research compatibility]] — Support for Roam Research syntax
- [[Citations]] — Academic citation support - [[features/Citations|Citations]] — Academic citation support
- [[Canvas]] — Render Obsidian Canvas files as interactive pages - [[Canvas]] — Render Obsidian Canvas files as interactive pages
- [[Bases]] — Database-like views for your notes (tables, cards, galleries, and more) - [[Bases]] — Database-like views for your notes (tables, cards, galleries, and more)
@@ -22,9 +22,9 @@ Quartz comes with a wide variety of features out of the box. Most features are p
- [[full-text search]] — Search across all your notes - [[full-text search]] — Search across all your notes
- [[graph view]] — Interactive graph visualization of note connections - [[graph view]] — Interactive graph visualization of note connections
- [[backlinks]] — See which notes link to the current page - [[features/backlinks]] — See which notes link to the current page
- [[explorer]] — File tree sidebar for browsing notes - [[features/explorer]] — File tree sidebar for browsing notes
- [[breadcrumbs]] — Breadcrumb navigation trail - [[features/breadcrumbs]] — Breadcrumb navigation trail
- [[table of contents]] — Per-page table of contents - [[table of contents]] — Per-page table of contents
- [[folder and tag listings]] — Browse notes by folder or tag - [[folder and tag listings]] — Browse notes by folder or tag
- [[recent notes]] — Display recently modified notes - [[recent notes]] — Display recently modified notes
@@ -34,9 +34,9 @@ Quartz comes with a wide variety of features out of the box. Most features are p
## Appearance & Reading ## Appearance & Reading
- [[darkmode]] — Light and dark mode toggle - [[features/darkmode]] — Light and dark mode toggle
- [[reader mode]] — Distraction-free reading experience - [[reader mode]] — Distraction-free reading experience
- [[comments]] — Add comments via Giscus, Utterances, or other providers - [[features/comments|comments]] — Add comments via Giscus, Utterances, or other providers
- [[social images]] — Auto-generated Open Graph images for social sharing - [[social images]] — Auto-generated Open Graph images for social sharing
## Publishing & Deployment ## Publishing & Deployment

2
docs/getting-started/authoring-content.md
View File

@@ -42,7 +42,7 @@ See [[Frontmatter]] for a complete list of frontmatter.
## Syncing your Content ## Syncing your Content
When your Quartz is at a point you're happy with, you can save your changes to GitHub. When your Quartz is at a point you're happy with, you can save your changes to GitHub.
First, make sure you've [[getting-started/installation|already setup your GitHub repository]] and then do `npx quartz sync`. First, make sure you've [[installation|already setup your GitHub repository]] and then do `npx quartz sync`.
## Customization ## Customization

8
docs/getting-started/index.md
View File

@@ -6,12 +6,12 @@ Welcome to Quartz! This section will walk you through setting up your digital ga
## Setup ## Setup
1. **[[getting-started/installation|Installation]]** — Clone Quartz, create your repository, and push your first sync 1. **[[installation|Installation]]** — Clone Quartz, create your repository, and push your first sync
2. **[[getting-started/authoring-content|Authoring Content]]** — Write and organize your notes in the `content` folder 2. **[[authoring-content|Authoring Content]]** — Write and organize your notes in the `content` folder
3. **[[build|Building]]** — Preview your site locally with `npx quartz build --serve` 3. **[[build|Building]]** — Preview your site locally with `npx quartz build --serve`
4. **[[hosting|Hosting]]** — Deploy your Quartz site to the web 4. **[[hosting|Hosting]]** — Deploy your Quartz site to the web
## Upgrading & Migrating ## Upgrading & Migrating
- **[[getting-started/upgrading|Upgrading Quartz]]** — Keep your Quartz installation up to date - **[[upgrading|Upgrading Quartz]]** — Keep your Quartz installation up to date
- **[[getting-started/migrating|Migrating to Quartz 5]]** — Migrate from Quartz 4 or Quartz 3 - **[[migrating|Migrating to Quartz 5]]** — Migrate from Quartz 4 or Quartz 3

4
docs/getting-started/migrating.md
View File

@@ -5,9 +5,9 @@ aliases:
- "migrating from Quartz 4" - "migrating from Quartz 4"
--- ---
This guide covers migrating to Quartz 5 from previous versions. If you're already on Quartz 5 and want to update to the latest version, see [[getting-started/upgrading|Upgrading Quartz]] instead. This guide covers migrating to Quartz 5 from previous versions. If you're already on Quartz 5 and want to update to the latest version, see [[upgrading|Upgrading Quartz]] instead.
If you're new to Quartz entirely, skip this guide and follow the [[getting-started/installation|Installation guide]] instead. If you're new to Quartz entirely, skip this guide and follow the [[installation|Installation guide]] instead.
## Before You Start: Save Your Content ## Before You Start: Save Your Content

4
docs/getting-started/upgrading.md
View File

@@ -5,7 +5,7 @@ aliases:
--- ---
> [!note] > [!note]
> This is specifically a guide for upgrading your Quartz to a more recent update. If you are coming from Quartz 4 or Quartz 3, check out the [[getting-started/migrating|migration guide]] for more info. > This is specifically a guide for upgrading your Quartz to a more recent update. If you are coming from Quartz 4 or Quartz 3, check out the [[migrating|migration guide]] for more info.
To fetch the latest Quartz updates, simply run To fetch the latest Quartz updates, simply run
@@ -26,7 +26,7 @@ To update your installed plugins separately, use:
npx quartz plugin install --latest npx quartz plugin install --latest
``` ```
See the [[cli/upgrade|CLI reference for upgrade]] for more details on available flags. See the [[upgrade|CLI reference for upgrade]] for more details on available flags.
### Cleaning Up Unused Plugins ### Cleaning Up Unused Plugins

2
docs/hosting.md
View File

@@ -36,7 +36,7 @@ To add a custom domain, check out [Cloudflare's documentation](https://developer
> Cloudflare Pages performs a shallow clone by default, so if you rely on `git` for timestamps, it is recommended that you add `git fetch --unshallow &&` to the beginning of the build command (e.g., `git fetch --unshallow && npx quartz plugin install && npx quartz build`). > Cloudflare Pages performs a shallow clone by default, so if you rely on `git` for timestamps, it is recommended that you add `git fetch --unshallow &&` to the beginning of the build command (e.g., `git fetch --unshallow && npx quartz plugin install && npx quartz build`).
> [!note] > [!note]
> For more detailed CI/CD configuration including caching and plugin management, see [[getting-started/migrating#Updating Your CI/CD|the migration guide]]. > For more detailed CI/CD configuration including caching and plugin management, see [[migrating#Updating Your CI/CD|the migration guide]].
## GitHub Pages ## GitHub Pages

6
docs/index.md
View File

@@ -10,8 +10,8 @@ Quartz requires **at least [Node](https://nodejs.org/) v22** and `npm` v10.9.2 t
### New to Quartz? ### New to Quartz?
1. **[[getting-started/installation|Set up your repository]]** — Fork and clone the Quartz template 1. **[[installation|Set up your repository]]** — Fork and clone the Quartz template
2. **[[getting-started/installation|Initialize]]** — Run `npx quartz create` to choose a template and configure your site 2. **[[installation|Initialize]]** — Run `npx quartz create` to choose a template and configure your site
3. **[[build|Build]]** — Preview your site locally with `npx quartz build --serve` 3. **[[build|Build]]** — Preview your site locally with `npx quartz build --serve`
4. **[[hosting|Deploy]]** — Host your site for free on GitHub Pages, Cloudflare, or Netlify 4. **[[hosting|Deploy]]** — Host your site for free on GitHub Pages, Cloudflare, or Netlify
@@ -26,7 +26,7 @@ npx quartz build --serve
## 🔧 Features ## 🔧 Features
- [[Obsidian compatibility]], [[full-text search]], [[graph view]], [[wikilinks|wikilinks, transclusions]], [[backlinks]], [[features/Latex|Latex]], [[syntax highlighting]], [[popover previews]], [[Docker Support]], [[i18n|internationalization]], [[comments]] and [many more](./features/) right out of the box - [[Obsidian compatibility]], [[full-text search]], [[graph view]], [[wikilinks|wikilinks, transclusions]], [[plugins/Backlinks]], [[features/Latex|Latex]], [[syntax highlighting]], [[popover previews]], [[Docker Support]], [[i18n|internationalization]], [[features/comments|comments]] and [many more](./features/) right out of the box
- Hot-reload on configuration edits and incremental rebuilds for content edits - Hot-reload on configuration edits and incremental rebuilds for content edits
- Simple JSX layouts and [[creating components|page components]] - Simple JSX layouts and [[creating components|page components]]
- [[SPA Routing|Ridiculously fast page loads]] and tiny bundle sizes - [[SPA Routing|Ridiculously fast page loads]] and tiny bundle sizes

2
docs/layout.md
View File

@@ -178,7 +178,7 @@ Plugins can ship their own frames by declaring them in `package.json` and export
**2. Core frames (for project-specific frames):** **2. Core frames (for project-specific frames):**
You can also create frames directly in `quartz/components/frames/` by implementing the `PageFrame` interface and registering the frame in `quartz/components/frames/index.ts`. See the [[advanced/architecture|architecture overview]] for the full `PageFrame` interface. You can also create frames directly in `quartz/components/frames/` by implementing the `PageFrame` interface and registering the frame in `quartz/components/frames/index.ts`. See the [[architecture|architecture overview]] for the full `PageFrame` interface.
Frames are applied as a `data-frame` attribute on the `.page` element, which you can target in CSS: Frames are applied as a `data-frame` attribute on the `.page` element, which you can target in CSS:

2
docs/plugins/Backlinks.md
View File

@@ -10,7 +10,7 @@ Shows pages that link to the current page.
> [!note] > [!note]
> For information on how to add, remove or configure plugins, see the [[configuration#Plugins|Configuration]] page. > For information on how to add, remove or configure plugins, see the [[configuration#Plugins|Configuration]] page.
See [[backlinks]] for detailed usage information. See [[plugins/Backlinks]] for detailed usage information.
## Configuration ## Configuration

2
docs/plugins/Breadcrumbs.md
View File

@@ -10,7 +10,7 @@ Navigation breadcrumb trail.
> [!note] > [!note]
> For information on how to add, remove or configure plugins, see the [[configuration#Plugins|Configuration]] page. > For information on how to add, remove or configure plugins, see the [[configuration#Plugins|Configuration]] page.
See [[breadcrumbs]] for detailed usage information. See [[plugins/Breadcrumbs]] for detailed usage information.
## Configuration ## Configuration

2
docs/plugins/Comments.md
View File

@@ -10,7 +10,7 @@ Comment system (giscus, utterances, etc.).
> [!note] > [!note]
> For information on how to add, remove or configure plugins, see the [[configuration#Plugins|Configuration]] page. > For information on how to add, remove or configure plugins, see the [[configuration#Plugins|Configuration]] page.
See [[comments]] for detailed usage information. See [[plugins/Comments]] for detailed usage information.
## Configuration ## Configuration

2
docs/plugins/Darkmode.md
View File

@@ -10,7 +10,7 @@ Dark mode toggle.
> [!note] > [!note]
> For information on how to add, remove or configure plugins, see the [[configuration#Plugins|Configuration]] page. > For information on how to add, remove or configure plugins, see the [[configuration#Plugins|Configuration]] page.
See [[darkmode]] for detailed usage information. See [[plugins/Darkmode]] for detailed usage information.
## Configuration ## Configuration

2
docs/plugins/Explorer.md
View File

@@ -10,7 +10,7 @@ File tree explorer sidebar.
> [!note] > [!note]
> For information on how to add, remove or configure plugins, see the [[configuration#Plugins|Configuration]] page. > For information on how to add, remove or configure plugins, see the [[configuration#Plugins|Configuration]] page.
See [[explorer]] for detailed usage information. See [[plugins/Explorer]] for detailed usage information.
## Configuration ## Configuration

2
docs/plugins/Frontmatter.md
View File

@@ -52,7 +52,7 @@ This plugin accepts the following configuration options:
When enabled, this plugin renders a collapsible "Properties" panel before the page body. The panel displays selected frontmatter fields in a table with automatic type rendering: When enabled, this plugin renders a collapsible "Properties" panel before the page body. The panel displays selected frontmatter fields in a table with automatic type rendering:
- **Strings** are shown as plain text. [[Wikilinks]] and [markdown links](https://example.com) within strings are rendered as clickable links. Wikilink targets are slugified the same way as body-content links (e.g. `[[My Note]]` resolves to `my-note`) and matching is case-insensitive to mirror Obsidian's behavior, so `[[MyNote]]`, `[[mynote]]`, and `[[MYNOTE]]` all point to the same page. - **Strings** are shown as plain text. [[wikilinks]] and [markdown links](https://example.com) within strings are rendered as clickable links. Wikilink targets are slugified the same way as body-content links (e.g. `[[My Note]]` resolves to `my-note`) and matching is case-insensitive to mirror Obsidian's behavior, so `[[MyNote]]`, `[[mynote]]`, and `[[MYNOTE]]` all point to the same page.
- **Arrays** are rendered as comma-separated lists. - **Arrays** are rendered as comma-separated lists.
- **Booleans** are rendered as disabled checkboxes. - **Booleans** are rendered as disabled checkboxes.
- **Numbers** are rendered in a monospace font. - **Numbers** are rendered in a monospace font.

4
docs/plugins/RoamFlavoredMarkdown.md
View File

@@ -5,10 +5,10 @@ tags:
image: image:
--- ---
This plugin provides support for [Roam Research](https://roamresearch.com) compatibility. See [[Roam Research Compatibility]] for more information. This plugin provides support for [Roam Research](https://roamresearch.com) compatibility. See [[Roam Research compatibility]] for more information.
> [!note] > [!note]
> For information on how to add, remove or configure plugins, see the [[Configuration#Plugins|Configuration]] page. > For information on how to add, remove or configure plugins, see the [[configuration#Plugins|Configuration]] page.
This plugin accepts the following configuration options: This plugin accepts the following configuration options:

44
docs/plugins/index.md
View File

@@ -35,9 +35,9 @@ Quartz plugins fall into several categories:
| [[CrawlLinks]] | [`quartz-community/crawl-links`](https://github.com/quartz-community/crawl-links) | ✅ | ⚠️ | Parses and resolves links. Removing it is not recommended. | | [[CrawlLinks]] | [`quartz-community/crawl-links`](https://github.com/quartz-community/crawl-links) | ✅ | ⚠️ | Parses and resolves links. Removing it is not recommended. |
| [[Description]] | [`quartz-community/description`](https://github.com/quartz-community/description) | ✅ | ❌ | Generates page descriptions for metadata. | | [[Description]] | [`quartz-community/description`](https://github.com/quartz-community/description) | ✅ | ❌ | Generates page descriptions for metadata. |
| [[UnlistedPages]] | [`quartz-community/unlisted-pages`](https://github.com/quartz-community/unlisted-pages) | ✅ | ❌ | Bridges `frontmatter.unlisted` to `file.data.unlisted` so any page can opt out of discovery. | | [[UnlistedPages]] | [`quartz-community/unlisted-pages`](https://github.com/quartz-community/unlisted-pages) | ✅ | ❌ | Bridges `frontmatter.unlisted` to `file.data.unlisted` so any page can opt out of discovery. |
| [[Latex]] | [`quartz-community/latex`](https://github.com/quartz-community/latex) | ✅ | ❌ | Renders LaTeX math expressions. | | [[plugins/Latex\|Latex]] | [`quartz-community/latex`](https://github.com/quartz-community/latex) | ✅ | ❌ | Renders LaTeX math expressions. |
| [[EncryptedPages]] | [`quartz-community/encrypted-pages`](https://github.com/quartz-community/encrypted-pages) | ✅ | ❌ | Password-protected encrypted pages with shadow content index.² | | [[EncryptedPages]] | [`quartz-community/encrypted-pages`](https://github.com/quartz-community/encrypted-pages) | ✅ | ❌ | Password-protected encrypted pages with shadow content index.² |
| [[Citations]] | [`quartz-community/citations`](https://github.com/quartz-community/citations) | ❌ | ❌ | Academic citation support via BibTeX. | | [[plugins/Citations\|Citations]] | [`quartz-community/citations`](https://github.com/quartz-community/citations) | ❌ | ❌ | Academic citation support via BibTeX. |
| [[HardLineBreaks]] | [`quartz-community/hard-line-breaks`](https://github.com/quartz-community/hard-line-breaks) | ❌ | ❌ | Treats single newlines as hard line breaks. | | [[HardLineBreaks]] | [`quartz-community/hard-line-breaks`](https://github.com/quartz-community/hard-line-breaks) | ❌ | ❌ | Treats single newlines as hard line breaks. |
| [[OxHugoFlavoredMarkdown]] | [`quartz-community/ox-hugo`](https://github.com/quartz-community/ox-hugo) | ❌ | ❌ | ox-hugo Markdown compatibility. | | [[OxHugoFlavoredMarkdown]] | [`quartz-community/ox-hugo`](https://github.com/quartz-community/ox-hugo) | ❌ | ❌ | ox-hugo Markdown compatibility. |
| [[RoamFlavoredMarkdown]] | [`quartz-community/roam`](https://github.com/quartz-community/roam) | ❌ | ❌ | Roam Research Markdown compatibility. | | [[RoamFlavoredMarkdown]] | [`quartz-community/roam`](https://github.com/quartz-community/roam) | ❌ | ❌ | Roam Research Markdown compatibility. |
@@ -72,26 +72,26 @@ Quartz plugins fall into several categories:
### Components ### Components
| Plugin | Repository | Enabled | Required | Description | | Plugin | Repository | Enabled | Required | Description |
| ------------------------------ | --------------------------------------------------------------------------------------------- | :-----: | :------: | ------------------------------------------------ | | ------------------------------------ | --------------------------------------------------------------------------------------------- | :-----: | :------: | ------------------------------------------------ |
| [[ArticleTitle]] | [`quartz-community/article-title`](https://github.com/quartz-community/article-title) | ✅ | ❌ | Renders the article title as an h1 heading. | | [[ArticleTitle]] | [`quartz-community/article-title`](https://github.com/quartz-community/article-title) | ✅ | ❌ | Renders the article title as an h1 heading. |
| [[ContentMeta]] | [`quartz-community/content-meta`](https://github.com/quartz-community/content-meta) | ✅ | ❌ | Displays creation date and reading time. | | [[ContentMeta]] | [`quartz-community/content-meta`](https://github.com/quartz-community/content-meta) | ✅ | ❌ | Displays creation date and reading time. |
| [[TagList]] | [`quartz-community/tag-list`](https://github.com/quartz-community/tag-list) | ❌ | ❌ | Renders tags as clickable links. | | [[TagList]] | [`quartz-community/tag-list`](https://github.com/quartz-community/tag-list) | ❌ | ❌ | Renders tags as clickable links. |
| [[PageTitle]] | [`quartz-community/page-title`](https://github.com/quartz-community/page-title) | ✅ | ❌ | Renders the site title as a home link. | | [[PageTitle]] | [`quartz-community/page-title`](https://github.com/quartz-community/page-title) | ✅ | ❌ | Renders the site title as a home link. |
| [[darkmode\|Darkmode]] | [`quartz-community/darkmode`](https://github.com/quartz-community/darkmode) | ✅ | ❌ | Toggle between light and dark themes. | | [[plugins/Darkmode\|Darkmode]] | [`quartz-community/darkmode`](https://github.com/quartz-community/darkmode) | ✅ | ❌ | Toggle between light and dark themes. |
| [[reader mode\|Reader Mode]] | [`quartz-community/reader-mode`](https://github.com/quartz-community/reader-mode) | ✅ | ❌ | Distraction-free reading mode toggle. | | [[reader mode\|Reader Mode]] | [`quartz-community/reader-mode`](https://github.com/quartz-community/reader-mode) | ✅ | ❌ | Distraction-free reading mode toggle. |
| [[explorer\|Explorer]] | [`quartz-community/explorer`](https://github.com/quartz-community/explorer) | ✅ | ❌ | File tree explorer sidebar. | | [[plugins/Explorer\|Explorer]] | [`quartz-community/explorer`](https://github.com/quartz-community/explorer) | ✅ | ❌ | File tree explorer sidebar. |
| [[graph view\|Graph View]] | [`quartz-community/graph`](https://github.com/quartz-community/graph) | ✅ | ❌ | Interactive link graph visualization. | | [[graph view\|Graph View]] | [`quartz-community/graph`](https://github.com/quartz-community/graph) | ✅ | ❌ | Interactive link graph visualization. |
| [[full-text search\|Search]] | [`quartz-community/search`](https://github.com/quartz-community/search) | ✅ | ❌ | Full-text search functionality. | | [[full-text search\|Search]] | [`quartz-community/search`](https://github.com/quartz-community/search) | ✅ | ❌ | Full-text search functionality. |
| [[backlinks\|Backlinks]] | [`quartz-community/backlinks`](https://github.com/quartz-community/backlinks) | ✅ | ❌ | Shows pages that link to the current page. | | [[plugins/Backlinks\|Backlinks]] | [`quartz-community/backlinks`](https://github.com/quartz-community/backlinks) | ✅ | ❌ | Shows pages that link to the current page. |
| [[breadcrumbs\|Breadcrumbs]] | [`quartz-community/breadcrumbs`](https://github.com/quartz-community/breadcrumbs) | ✅ | ❌ | Breadcrumb navigation trail. | | [[plugins/Breadcrumbs\|Breadcrumbs]] | [`quartz-community/breadcrumbs`](https://github.com/quartz-community/breadcrumbs) | ✅ | ❌ | Breadcrumb navigation trail. |
| [[comments\|Comments]] | [`quartz-community/comments`](https://github.com/quartz-community/comments) | ❌ | ❌ | Comment system integration (Giscus, etc.). | | [[plugins/Comments\|Comments]] | [`quartz-community/comments`](https://github.com/quartz-community/comments) | ❌ | ❌ | Comment system integration (Giscus, etc.). |
| [[Footer]] | [`quartz-community/footer`](https://github.com/quartz-community/footer) | ✅ | ❌ | Page footer with configurable links. | | [[Footer]] | [`quartz-community/footer`](https://github.com/quartz-community/footer) | ✅ | ❌ | Page footer with configurable links. |
| [[recent notes\|Recent Notes]] | [`quartz-community/recent-notes`](https://github.com/quartz-community/recent-notes) | ❌ | ❌ | Displays a list of recently modified notes. | | [[RecentNotes\|Recent Notes]] | [`quartz-community/recent-notes`](https://github.com/quartz-community/recent-notes) | ❌ | ❌ | Displays a list of recently modified notes. |
| [[Spacer]] | [`quartz-community/spacer`](https://github.com/quartz-community/spacer) | ✅ | ❌ | Flexible spacer for layout groups. | | [[Spacer]] | [`quartz-community/spacer`](https://github.com/quartz-community/spacer) | ✅ | ❌ | Flexible spacer for layout groups. |
| [[TableOfContents]]¹ | [`quartz-community/table-of-contents`](https://github.com/quartz-community/table-of-contents) | ✅ | ❌ | Renders the table of contents in the layout. | | [[TableOfContents]]¹ | [`quartz-community/table-of-contents`](https://github.com/quartz-community/table-of-contents) | ✅ | ❌ | Renders the table of contents in the layout. |
| [[EncryptedPages]]² | [`quartz-community/encrypted-pages`](https://github.com/quartz-community/encrypted-pages) | ✅ | ❌ | Renders the password prompt for encrypted pages. | | [[EncryptedPages]]² | [`quartz-community/encrypted-pages`](https://github.com/quartz-community/encrypted-pages) | ✅ | ❌ | Renders the password prompt for encrypted pages. |
| [[StackedPages]] | [`quartz-community/stacked-pages`](https://github.com/quartz-community/stacked-pages) | ✅ | ❌ | Andy Matuschak-style stacked sliding panes. | | [[StackedPages]] | [`quartz-community/stacked-pages`](https://github.com/quartz-community/stacked-pages) | ✅ | ❌ | Andy Matuschak-style stacked sliding panes. |
> ¹ TableOfContents is a dual-category plugin (transformer + component). It appears in both the Transformers and Components tables. > ¹ TableOfContents is a dual-category plugin (transformer + component). It appears in both the Transformers and Components tables.
> >