Merge commit '4bbcc0c50aca68d470542c1af8fd5f8060d97ab8' into HEAD

docs/features/comments.md

@@ -0,0 +1,83 @@
+---
+title: Comments
+tags:
+  - component
+---
+
+Quartz also has the ability to hook into various providers to enable readers to leave comments on your site.
+
+![[giscus-example.png]]
+
+As of today, only [Giscus](https://giscus.app/) is supported out of the box but PRs to support other providers are welcome!
+
+## Providers
+
+### Giscus
+
+First, make sure that the [[setting up your GitHub repository|GitHub]] repository you are using for your Quartz meets the following requirements:
+
+1. The **repository is [public](https://docs.github.com/en/github/administering-a-repository/managing-repository-settings/setting-repository-visibility#making-a-repository-public)**, otherwise visitors will not be able to view the discussion.
+2. The **[giscus](https://github.com/apps/giscus) app is installed**, otherwise visitors will not be able to comment and react.
+3. The **Discussions feature is turned on** by [enabling it for your repository](https://docs.github.com/en/github/administering-a-repository/managing-repository-settings/enabling-or-disabling-github-discussions-for-a-repository).
+
+Then, use the [Giscus site](https://giscus.app/#repository) to figure out what your `repoId` and `categoryId` should be. Make sure you select `Announcements` for the Discussion category.
+
+![[giscus-repo.png]]
+
+![[giscus-discussion.png]]
+
+After entering both your repository and selecting the discussion category, Giscus will compute some IDs that you'll need to provide back to Quartz. You won't need to manually add the script yourself as Quartz will handle that part for you but will need these values in the next step!
+
+![[giscus-results.png]]
+
+Finally, in `quartz.layout.ts`, edit the `afterBody` field of `sharedPageComponents` to include the following options but with the values you got from above:
+
+```ts title="quartz.layout.ts"
+afterBody: [
+  Component.Comments({
+    provider: 'giscus',
+    options: {
+      // from data-repo
+      repo: 'jackyzha0/quartz',
+      // from data-repo-id
+      repoId: 'MDEwOlJlcG9zaXRvcnkzODcyMTMyMDg',
+      // from data-category
+      category: 'Announcements',
+      // from data-category-id
+      categoryId: 'DIC_kwDOFxRnmM4B-Xg6',
+    }
+  }),
+],
+```
+
+### Customization
+
+Quartz also exposes a few of the other Giscus options as well and you can provide them the same way `repo`, `repoId`, `category`, and `categoryId` are provided.
+
+```ts
+type Options = {
+  provider: "giscus"
+  options: {
+    repo: `${string}/${string}`
+    repoId: string
+    category: string
+    categoryId: string
+
+    // how to map pages -> discussions
+    // defaults to 'url'
+    mapping?: "url" | "title" | "og:title" | "specific" | "number" | "pathname"
+
+    // use strict title matching
+    // defaults to true
+    strict?: boolean
+
+    // whether to enable reactions for the main post
+    // defaults to true
+    reactionsEnabled?: boolean
+
+    // where to put the comment input box relative to the comments
+    // defaults to 'bottom'
+    inputPosition?: "top" | "bottom"
+  }
+}
+```

docs/features/i18n.md

@@ -0,0 +1,18 @@
+---
+title: Internationalization
+---
+
+Internationalization allows users to translate text in the Quartz interface into various supported languages without needing to make extensive code changes. This can be changed via the `locale` [[configuration]] field in `quartz.config.ts`.
+
+The locale field generally follows a certain format: `{language}-{REGION}`
+
+- `{language}` is usually a [2-letter lowercase language code](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes).
+- `{REGION}` is usually a [2-letter uppercase region code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)
+
+> [!tip] Interested in contributing?
+> We [gladly welcome translation PRs](https://github.com/jackyzha0/quartz/tree/v4/quartz/i18n/locales)! To contribute a translation, do the following things:
+>
+> 1. In the `quartz/i18n/locales` folder, copy the `en-US.ts` file.
+> 2. Rename it to `{language}-{REGION}.ts` so it matches a locale of the format shown above.
+> 3. Fill in the translations!
+> 4. Add the entry under `TRANSLATIONS` in `quartz/i18n/index.ts`.

docs/plugins/AliasRedirects.md

@@ -0,0 +1,37 @@
+---
+title: AliasRedirects
+tags:
+  - plugin/emitter
+---
+
+This plugin emits HTML redirect pages for aliases and permalinks defined in the frontmatter of content files.
+
+For example, A `foo.md` has the following frontmatter
+
+```md title="foo.md"
+---
+title: "Foo"
+alias:
+  - "bar"
+---
+```
+
+The target `host.me/bar` will be redirected to `host.me/foo`
+
+Note that these are permanent redirect.
+
+The emitter supports the following aliases:
+
+- `aliases`
+- `alias`
+
+> [!note]
+> For information on how to add, remove or configure plugins, see the [[configuration#Plugins|Configuration]] page.
+
+This plugin has no configuration options.
+
+## API
+
+- Category: Emitter
+- Function name: `Plugin.AliasRedirects()`.
+- Source: [`quartz/plugins/emitters/aliases.ts`](https://github.com/jackyzha0/quartz/blob/v4/quartz/plugins/emitters/aliases.ts).

docs/plugins/Assets.md

@@ -0,0 +1,20 @@
+---
+title: Assets
+tags:
+  - plugin/emitter
+---
+
+This plugin emits all non-Markdown static assets in your content folder (like images, videos, HTML, etc). The plugin respects the `ignorePatterns` in the global [[configuration]].
+
+Note that all static assets will then be accessible through its path on your generated site, i.e: `host.me/path/to/static.pdf`
+
+> [!note]
+> For information on how to add, remove or configure plugins, see the [[configuration#Plugins|Configuration]] page.
+
+This plugin has no configuration options.
+
+## API
+
+- Category: Emitter
+- Function name: `Plugin.Assets()`.
+- Source: [`quartz/plugins/emitters/assets.ts`](https://github.com/jackyzha0/quartz/blob/v4/quartz/plugins/emitters/assets.ts).

docs/plugins/CNAME.md

@@ -0,0 +1,22 @@
+---
+title: CNAME
+tags:
+  - plugin/emitter
+---
+
+This plugin emits a `CNAME` record that points your subdomain to the default domain of your site.
+
+If you want to use a custom domain name like `quartz.example.com` for the site, then this is needed.
+
+See [[hosting|Hosting]] for more information.
+
+> [!note]
+> For information on how to add, remove or configure plugins, see the [[configuration#Plugins|Configuration]] page.
+
+This plugin has no configuration options.
+
+## API
+
+- Category: Emitter
+- Function name: `Plugin.CNAME()`.
+- Source: [`quartz/plugins/emitters/cname.ts`](https://github.com/jackyzha0/quartz/blob/v4/quartz/plugins/emitters/cname.ts).

docs/plugins/ComponentResources.md

@@ -0,0 +1,18 @@
+---
+title: ComponentResources
+tags:
+  - plugin/emitter
+---
+
+This plugin manages and emits the static resources required for the Quartz framework. This includes CSS stylesheets and JavaScript scripts that enhance the functionality and aesthetics of the generated site. See also the `cdnCaching` option in the `theme` section of the [[configuration]].
+
+> [!note]
+> For information on how to add, remove or configure plugins, see the [[configuration#Plugins|Configuration]] page.
+
+This plugin has no configuration options.
+
+## API
+
+- Category: Emitter
+- Function name: `Plugin.ComponentResources()`.
+- Source: [`quartz/plugins/emitters/componentResources.ts`](https://github.com/jackyzha0/quartz/blob/v4/quartz/plugins/emitters/componentResources.ts).

docs/plugins/ContentIndex.md

@@ -0,0 +1,26 @@
+---
+title: ContentIndex
+tags:
+  - plugin/emitter
+---
+
+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.
+
+This plugin emits a comprehensive index of the site's content, generating additional resources such as a sitemap, an RSS feed, and a
+
+> [!note]
+> For information on how to add, remove or configure plugins, see the [[configuration#Plugins|Configuration]] page.
+
+This plugin accepts the following configuration options:
+
+- `enableSiteMap`: If `true` (default), generates a sitemap XML file (`sitemap.xml`) listing all site URLs for search engines in content discovery.
+- `enableRSS`: If `true` (default), produces an RSS feed (`index.xml`) with recent content updates.
+- `rssLimit`: Defines the maximum number of entries to include in the RSS feed, helping to focus on the most recent or relevant content. Defaults to `10`.
+- `rssFullHtml`: If `true`, the RSS feed includes full HTML content. Otherwise it includes just summaries.
+- `includeEmptyFiles`: If `true` (default), content files with no body text are included in the generated index and resources.
+
+## API
+
+- Category: Emitter
+- Function name: `Plugin.ContentIndex()`.
+- Source: [`quartz/plugins/emitters/contentIndex.ts`](https://github.com/jackyzha0/quartz/blob/v4/quartz/plugins/emitters/contentIndex.ts).

docs/plugins/ContentPage.md

@@ -0,0 +1,18 @@
+---
+title: ContentPage
+tags:
+  - plugin/emitter
+---
+
+This plugin is a core component of 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.
+
+> [!note]
+> For information on how to add, remove or configure plugins, see the [[configuration#Plugins|Configuration]] page.
+
+This plugin has no configuration options.
+
+## API
+
+- Category: Emitter
+- Function name: `Plugin.ContentPage()`.
+- Source: [`quartz/plugins/emitters/contentPage.tsx`](https://github.com/jackyzha0/quartz/blob/v4/quartz/plugins/emitters/contentPage.tsx).

docs/plugins/CrawlLinks.md

@@ -0,0 +1,30 @@
+---
+title: CrawlLinks
+tags:
+  - plugin/transformer
+---
+
+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.
+
+> [!note]
+> For information on how to add, remove or configure plugins, see the [[configuration#Plugins|Configuration]] page.
+
+This plugin accepts the following configuration options:
+
+- `markdownLinkResolution`: Sets the strategy for resolving Markdown paths, can be `"absolute"` (default), `"relative"` or `"shortest"`. You should use the same setting here as in [[Obsidian compatibility|Obsidian]].
+  - `absolute`: Path relative to the root of the content folder.
+  - `relative`: Path relative to the file you are linking from.
+  - `shortest`: Name of the file. If this isn't enough to identify the file, use the full absolute path.
+- `prettyLinks`: If `true` (default), simplifies links by removing folder paths, making them more user friendly (e.g. `folder/deeply/nested/note` becomes `note`).
+- `openLinksInNewTab`: If `true`, configures external links to open in a new tab. Defaults to `false`.
+- `lazyLoad`: If `true`, adds lazy loading to resource elements (`img`, `video`, etc.) to improve page load performance. Defaults to `false`.
+- `externalLinkIcon`: Adds an icon next to external links when `true` (default) to visually distinguishing them from internal links.
+
+> [!warning]
+> Removing this plugin is _not_ recommended and will likely break the page.
+
+## API
+
+- Category: Transformer
+- Function name: `Plugin.CrawlLinks()`.
+- Source: [`quartz/plugins/transformers/links.ts`](https://github.com/jackyzha0/quartz/blob/v4/quartz/plugins/transformers/links.ts).

docs/plugins/CreatedModifiedDate.md

@@ -0,0 +1,25 @@
+---
+title: "CreatedModifiedDate"
+tags:
+  - plugin/transformer
+---
+
+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.
+
+> [!note]
+> For information on how to add, remove or configure plugins, see the [[configuration#Plugins|Configuration]] page.
+
+This plugin accepts the following configuration options:
+
+- `priority`: The data sources to consult for date information. Highest priority first. Possible values are `"frontmatter"`, `"git"`, and `"filesystem"`. Defaults to `["frontmatter", "git", "filesystem"]`.
+
+> [!warning]
+> If you rely on `git` for dates, make sure `defaultDateType` is set to `modified` in `quartz.config.ts`.
+>
+> Depending on how you [[hosting|host]] your Quartz, the `filesystem` dates of your local files may not match the final dates. In these cases, it may be better to use `git` or `frontmatter` to guarantee correct dates.
+
+## API
+
+- Category: Transformer
+- Function name: `Plugin.CreatedModifiedDate()`.
+- Source: [`quartz/plugins/transformers/lastmod.ts`](https://github.com/jackyzha0/quartz/blob/v4/quartz/plugins/transformers/lastmod.ts).

docs/plugins/Description.md

@@ -0,0 +1,23 @@
+---
+title: Description
+tags:
+  - plugin/transformer
+---
+
+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.
+
+If the frontmatter contains a `description` property, it is used (see [[authoring content#Syntax]]). Otherwise, the plugin will do its best to use the first few sentences of the content to reach the target description length.
+
+> [!note]
+> For information on how to add, remove or configure plugins, see the [[configuration#Plugins|Configuration]] page.
+
+This plugin accepts the following configuration options:
+
+- `descriptionLength`: the maximum length of the generated description. Default is 150 characters. The cut off happens after the first _sentence_ that ends after the given length.
+- `replaceExternalLinks`: If `true` (default), replace external links with their domain and path in the description (e.g. `https://domain.tld/some_page/another_page?query=hello&target=world` is replaced with `domain.tld/some_page/another_page`).
+
+## API
+
+- Category: Transformer
+- Function name: `Plugin.Description()`.
+- Source: [`quartz/plugins/transformers/description.ts`](https://github.com/jackyzha0/quartz/blob/v4/quartz/plugins/transformers/description.ts).

docs/plugins/ExplicitPublish.md

@@ -0,0 +1,18 @@
+---
+title: ExplicitPublish
+tags:
+  - plugin/filter
+---
+
+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.
+
+> [!note]
+> For information on how to add, remove or configure plugins, see the [[configuration#Plugins|Configuration]] page.
+
+This plugin has no configuration options.
+
+## API
+
+- Category: Filter
+- Function name: `Plugin.ExplicitPublish()`.
+- Source: [`quartz/plugins/filters/explicit.ts`](https://github.com/jackyzha0/quartz/blob/v4/quartz/plugins/filters/explicit.ts).

docs/plugins/FolderPage.md

@@ -0,0 +1,24 @@
+---
+title: FolderPage
+tags:
+  - plugin/emitter
+---
+
+This plugin generates index pages for folders, creating a listing page for each folder that contains multiple content files. See [[folder and tag listings]] for more information.
+
+Example: [[advanced/|Advanced]]
+
+> [!note]
+> For information on how to add, remove or configure plugins, see the [[configuration#Plugins|Configuration]] page.
+
+The pages are displayed using the `defaultListPageLayout` in `quartz.layouts.ts`. For the content, the `FolderContent` component is used. If you want to modify the layout, you must edit it directly (`quartz/components/pages/FolderContent.tsx`).
+
+This plugin accepts the following configuration options:
+
+- `sort`: A function of type `(f1: QuartzPluginData, f2: QuartzPluginData) => number{:ts}` used to sort entries. Defaults to sorting by date and tie-breaking on lexographical order.
+
+## API
+
+- Category: Emitter
+- Function name: `Plugin.FolderPage()`.
+- Source: [`quartz/plugins/emitters/folderPage.tsx`](https://github.com/jackyzha0/quartz/blob/v4/quartz/plugins/emitters/folderPage.tsx).

docs/plugins/Frontmatter.md

@@ -0,0 +1,24 @@
+---
+title: "Frontmatter"
+tags:
+  - plugin/transformer
+---
+
+This plugin parses the frontmatter of the page using the [gray-matter](https://github.com/jonschlinkert/gray-matter) library. See [[authoring content#Syntax]], [[Obsidian compatibility]] and [[OxHugo compatibility]] for more information.
+
+> [!note]
+> For information on how to add, remove or configure plugins, see the [[configuration#Plugins|Configuration]] page.
+
+This plugin accepts the following configuration options:
+
+- `delimiters`: the delimiters to use for the frontmatter. Can have one value (e.g. `"---"`) or separate values for opening and closing delimiters (e.g. `["---", "~~~"]`). Defaults to `"---"`.
+- `language`: the language to use for parsing the frontmatter. Can be `yaml` (default) or `toml`.
+
+> [!warning]
+> This plugin must not be removed, otherwise Quartz will break.
+
+## API
+
+- Category: Transformer
+- Function name: `Plugin.Frontmatter()`.
+- Source: [`quartz/plugins/transformers/frontmatter.ts`](https://github.com/jackyzha0/quartz/blob/v4/quartz/plugins/transformers/frontmatter.ts).

docs/plugins/GitHubFlavoredMarkdown.md

@@ -0,0 +1,23 @@
+---
+title: GitHubFlavoredMarkdown
+tags:
+  - plugin/transformer
+---
+
+This plugin enhances Markdown processing to support GitHub Flavored Markdown (GFM) which adds features like autolink literals, footnotes, strikethrough, tables and tasklists.
+
+In addition, this plugin adds optional features for typographic refinement (such as converting straight quotes to curly quotes, dashes to en-dashes/em-dashes, and ellipses) and automatic heading links as a symbol that appears next to the heading on hover.
+
+> [!note]
+> For information on how to add, remove or configure plugins, see the [[configuration#Plugins|Configuration]] page.
+
+This plugin accepts the following configuration options:
+
+- `enableSmartyPants`: When true, enables typographic enhancements. Default is true.
+- `linkHeadings`: When true, automatically adds links to headings. Default is true.
+
+## API
+
+- Category: Transformer
+- Function name: `Plugin.GitHubFlavoredMarkdown()`.
+- Source: [`quartz/plugins/transformers/gfm.ts`](https://github.com/jackyzha0/quartz/blob/v4/quartz/plugins/transformers/gfm.ts).

docs/plugins/HardLineBreaks.md

@@ -0,0 +1,18 @@
+---
+title: HardLineBreaks
+tags:
+  - plugin/transformer
+---
+
+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]].
+
+> [!note]
+> For information on how to add, remove or configure plugins, see the [[configuration#Plugins|Configuration]] page.
+
+This plugin has no configuration options.
+
+## API
+
+- Category: Transformer
+- Function name: `Plugin.HardLineBreaks()`.
+- Source: [`quartz/plugins/transformers/linebreaks.ts`](https://github.com/jackyzha0/quartz/blob/v4/quartz/plugins/transformers/linebreaks.ts).

docs/plugins/Latex.md

@@ -0,0 +1,20 @@
+---
+title: "Latex"
+tags:
+  - plugin/transformer
+---
+
+This plugin adds LaTeX support to Quartz. See [[features/Latex|Latex]] for more information.
+
+> [!note]
+> For information on how to add, remove or configure plugins, see the [[configuration#Plugins|Configuration]] page.
+
+This plugin accepts the following configuration options:
+
+- `renderEngine`: the engine to use to render LaTeX equations. Can be `"katex"` for [KaTeX](https://katex.org/) or `"mathjax"` for [MathJax](https://www.mathjax.org/) [SVG rendering](https://docs.mathjax.org/en/latest/output/svg.html). Defaults to KaTeX.
+
+## API
+
+- Category: Transformer
+- Function name: `Plugin.Latex()`.
+- Source: [`quartz/plugins/transformers/latex.ts`](https://github.com/jackyzha0/quartz/blob/v4/quartz/plugins/transformers/latex.ts).

docs/plugins/NotFoundPage.md

@@ -0,0 +1,18 @@
+---
+title: NotFoundPage
+tags:
+  - plugin/emitter
+---
+
+This plugin emits a 404 (Not Found) page for broken or non-existent URLs.
+
+> [!note]
+> For information on how to add, remove or configure plugins, see the [[configuration#Plugins|Configuration]] page.
+
+This plugin has no configuration options.
+
+## API
+
+- Category: Emitter
+- Function name: `Plugin.NotFoundPage()`.
+- Source: [`quartz/plugins/emitters/404.tsx`](https://github.com/jackyzha0/quartz/blob/v4/quartz/plugins/emitters/404.tsx).

docs/plugins/ObsidianFlavoredMarkdown.md

@@ -0,0 +1,34 @@
+---
+title: ObsidianFlavoredMarkdown
+tags:
+  - plugin/transformer
+---
+
+This plugin provides support for [[Obsidian compatibility]].
+
+> [!note]
+> For information on how to add, remove or configure plugins, see the [[configuration#Plugins|Configuration]] page.
+
+This plugin accepts the following configuration options:
+
+- `comments`: If `true` (default), enables parsing of `%%` style Obsidian comment blocks.
+- `highlight`: If `true` (default), enables parsing of `==` style highlights within content.
+- `wikilinks`:If `true` (default), turns [[wikilinks]] into regular links.
+- `callouts`: If `true` (default), adds support for [[callouts|callout]] blocks for emphasizing content.
+- `mermaid`: If `true` (default), enables [[Mermaid diagrams|Mermaid diagram]] rendering within Markdown files.
+- `parseTags`: If `true` (default), parses and links tags within the content.
+- `parseArrows`: If `true` (default), transforms arrow symbols into their HTML character equivalents.
+- `parseBlockReferences`: If `true` (default), handles block references, linking to specific content blocks.
+- `enableInHtmlEmbed`: If `true`, allows embedding of content directly within HTML. Defaults to `false`.
+- `enableYouTubeEmbed`: If `true` (default), enables the embedding of YouTube videos and playlists using external image Markdown syntax.
+- `enableVideoEmbed`: If `true` (default), enables the embedding of video files.
+- `enableCheckbox`: If `true`, adds support for interactive checkboxes in content. Defaults to `false`.
+
+> [!warning]
+> Don't remove this plugin if you're using [[Obsidian compatibility|Obsidian]] to author the content!
+
+## API
+
+- Category: Transformer
+- Function name: `Plugin.ObsidianFlavoredMarkdown()`.
+- Source: [`quartz/plugins/transformers/toc.ts`](https://github.com/jackyzha0/quartz/blob/v4/quartz/plugins/transformers/toc.ts).

docs/plugins/OxHugoFlavoredMarkdown.md

@@ -0,0 +1,29 @@
+---
+title: OxHugoFlavoredMarkdown
+tags:
+  - plugin/transformer
+---
+
+This plugin provides support for [ox-hugo](https://github.com/kaushalmodi/ox-hugo) compatibility. See [[OxHugo compatibility]] for more information.
+
+> [!note]
+> For information on how to add, remove or configure plugins, see the [[configuration#Plugins|Configuration]] page.
+
+This plugin accepts the following configuration options:
+
+- `wikilinks`: If `true` (default), converts Hugo `{{ relref }}` shortcodes to Quartz [[wikilinks]].
+- `removePredefinedAnchor`: If `true` (default), strips predefined anchors from headings.
+- `removeHugoShortcode`: If `true` (default), removes Hugo shortcode syntax (`{{}}`) from the content.
+- `replaceFigureWithMdImg`: If `true` (default), replaces `<figure/>` with `![]()`.
+- `replaceOrgLatex`: If `true` (default), converts Org-mode [[features/Latex|Latex]] fragments to Quartz-compatible LaTeX wrapped in `$` (for inline) and `$$` (for block equations).
+
+> [!warning]
+> While you can use this together with [[ObsidianFlavoredMarkdown]], it's not recommended because it might mutate the file in unexpected ways. Use with caution.
+>
+> If you use `toml` frontmatter, make sure to configure the [[Frontmatter]] plugin accordingly. See [[OxHugo compatibility]] for an example.
+
+## API
+
+- Category: Transformer
+- Function name: `Plugin.OxHugoFlavoredMarkdown()`.
+- Source: [`quartz/plugins/transformers/oxhugofm.ts`](https://github.com/jackyzha0/quartz/blob/v4/quartz/plugins/transformers/oxhugofm.ts).

docs/plugins/RemoveDrafts.md

@@ -0,0 +1,18 @@
+---
+title: RemoveDrafts
+tags:
+  - plugin/filter
+---
+
+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.
+
+> [!note]
+> For information on how to add, remove or configure plugins, see the [[configuration#Plugins|Configuration]] page.
+
+This plugin has no configuration options.
+
+## API
+
+- Category: Filter
+- Function name: `Plugin.RemoveDrafts()`.
+- Source: [`quartz/plugins/filters/draft.ts`](https://github.com/jackyzha0/quartz/blob/v4/quartz/plugins/filters/draft.ts).

docs/plugins/Static.md

@@ -0,0 +1,21 @@
+---
+title: Static
+tags:
+  - plugin/emitter
+---
+
+This plugin emits all static resources needed by Quartz. This is used, for example, for fonts and images that need a stable position, such as banners and icons. The plugin respects the `ignorePatterns` in the global [[configuration]].
+
+> [!important]
+> This is different from [[Assets]]. The resources from the [[Static]] plugin are located under `quartz/static`, whereas [[Assets]] renders all static resources under `content` and is used for images, videos, audio, etc. that are directly referenced by your markdown content.
+
+> [!note]
+> For information on how to add, remove or configure plugins, see the [[configuration#Plugins|Configuration]] page.
+
+This plugin has no configuration options.
+
+## API
+
+- Category: Emitter
+- Function name: `Plugin.Static()`.
+- Source: [`quartz/plugins/emitters/static.ts`](https://github.com/jackyzha0/quartz/blob/v4/quartz/plugins/emitters/static.ts).

docs/plugins/SyntaxHighlighting.md

@@ -0,0 +1,23 @@
+---
+title: "SyntaxHighlighting"
+tags:
+  - plugin/transformer
+---
+
+This plugin is used to add syntax highlighting to code blocks in Quartz. See [[syntax highlighting]] for more information.
+
+> [!note]
+> For information on how to add, remove or configure plugins, see the [[configuration#Plugins|Configuration]] page.
+
+This plugin accepts the following configuration options:
+
+- `theme`: a separate id of one of the [themes bundled with Shikiji](https://shikiji.netlify.app/themes). One for light mode and one for dark mode. Defaults to `theme: { light: "github-light", dark: "github-dark" }`.
+- `keepBackground`: If set to `true`, the background of the Shikiji theme will be used. With `false` (default) the Quartz theme color for background will be used instead.
+
+In addition, you can further override the colours in the `quartz/styles/syntax.scss` file.
+
+## API
+
+- Category: Transformer
+- Function name: `Plugin.SyntaxHighlighting()`.
+- Source: [`quartz/plugins/transformers/syntax.ts`](https://github.com/jackyzha0/quartz/blob/v4/quartz/plugins/transformers/syntax.ts).

docs/plugins/TableOfContents.md

@@ -0,0 +1,26 @@
+---
+title: TableOfContents
+tags:
+  - plugin/transformer
+---
+
+This plugin generates a table of contents (TOC) for Markdown documents. See [[table of contents]] for more information.
+
+> [!note]
+> For information on how to add, remove or configure plugins, see the [[configuration#Plugins|Configuration]] page.
+
+This plugin accepts the following configuration options:
+
+- `maxDepth`: Limits the depth of headings included in the TOC, ranging from `1` (top level headings only) to `6` (all heading levels). Default is `3`.
+- `minEntries`: The minimum number of heading entries required for the TOC to be displayed. Default is `1`.
+- `showByDefault`: If `true` (default), the TOC should be displayed by default. Can be overridden by frontmatter settings.
+- `collapseByDefault`: If `true`, the TOC will start in a collapsed state. Default is `false`.
+
+> [!warning]
+> This plugin needs the `Component.TableOfContents` component in `quartz.layout.ts` to determine where to display the TOC. Without it, nothing will be displayed. They should always be added or removed together.
+
+## API
+
+- Category: Transformer
+- Function name: `Plugin.TableOfContents()`.
+- Source: [`quartz/plugins/transformers/toc.ts`](https://github.com/jackyzha0/quartz/blob/v4/quartz/plugins/transformers/toc.ts).

docs/plugins/TagPage.md

@@ -0,0 +1,22 @@
+---
+title: TagPage
+tags:
+  - plugin/emitter
+---
+
+This plugin emits dedicated pages for each tag used in the content. See [[folder and tag listings]] for more information.
+
+> [!note]
+> For information on how to add, remove or configure plugins, see the [[configuration#Plugins|Configuration]] page.
+
+The pages are displayed using the `defaultListPageLayout` in `quartz.layouts.ts`. For the content, the `TagContent` component is used. If you want to modify the layout, you must edit it directly (`quartz/components/pages/TagContent.tsx`).
+
+This plugin accepts the following configuration options:
+
+- `sort`: A function of type `(f1: QuartzPluginData, f2: QuartzPluginData) => number{:ts}` used to sort entries. Defaults to sorting by date and tie-breaking on lexographical order.
+
+## API
+
+- Category: Emitter
+- Function name: `Plugin.TagPage()`.
+- Source: [`quartz/plugins/emitters/tagPage.tsx`](https://github.com/jackyzha0/quartz/blob/v4/quartz/plugins/emitters/tagPage.tsx).

docs/plugins/index.md

@@ -0,0 +1,3 @@
+---
+title: Plugins
+---

docs/setting up your GitHub repository.md

@@ -0,0 +1,48 @@
+---
+title: Setting up your GitHub repository
+---
+
+First, make sure you have Quartz [[index#🪴 Get Started|cloned and setup locally]].
+
+Then, create a new repository on GitHub.com. Do **not** initialize the new repository with `README`, license, or `gitignore` files.
+
+![[github-init-repo-options.png]]
+
+At the top of your repository on GitHub.com's Quick Setup page, click the clipboard to copy the remote repository URL.
+
+![[github-quick-setup.png]]
+
+In your terminal of choice, navigate to the root of your Quartz folder. Then, run the following commands, replacing `REMOTE-URL` with the URL you just copied from the previous step.
+
+```bash
+# list all the repositories that are tracked
+git remote -v
+
+# if the origin doesn't match your own repository, set your repository as the origin
+git remote set-url origin REMOTE-URL
+
+# if you don't have upstream as a remote, add it so updates work
+git remote add upstream https://github.com/jackyzha0/quartz.git
+```
+
+Then, you can sync the content to upload it to your repository. This is a helper command that will do the initial push of your content to your repository.
+
+```bash
+npx quartz sync --no-pull
+```
+
+> [!warning]- `fatal: --[no-]autostash option is only valid with --rebase`
+> You may have an outdated version of `git`. Updating `git` should fix this issue.
+
+In future updates, you can simply run `npx quartz sync` every time you want to push updates to your repository.
+
+> [!hint] Flags and options
+> For full help options, you can run `npx quartz sync --help`.
+>
+> Most of these have sensible defaults but you can override them if you have a custom setup:
+>
+> - `-d` or `--directory`: the content folder. This is normally just `content`
+> - `-v` or `--verbose`: print out extra logging information
+> - `--commit` or `--no-commit`: whether to make a `git` commit for your changes
+> - `--push` or `--no-push`: whether to push updates to your GitHub fork of Quartz
+> - `--pull` or `--no-pull`: whether to try and pull in any updates from your GitHub fork (i.e. from other devices) before pushing

docs/tags/plugin.md

@@ -0,0 +1,3 @@
+---
+title: Plugins
+---