docs: update plugin API sections for v5 community plugins

docs/plugins/AliasRedirects.md

@@ -33,5 +33,6 @@ This plugin has no configuration options.
 ## API
 
 - Category: Emitter
-- Function name: `Plugin.AliasRedirects()`.
+- Function name: `ExternalPlugin.AliasRedirects()`.
-- Source: [`quartz/plugins/emitters/aliases.ts`](https://github.com/jackyzha0/quartz/blob/v4/quartz/plugins/emitters/aliases.ts).
+- Source: [`quartz-community/alias-redirects`](https://github.com/quartz-community/alias-redirects)
+- Install: `npx quartz plugin add github:quartz-community/alias-redirects`

docs/plugins/Assets.md

@@ -17,4 +17,4 @@ This plugin has no configuration options.
 
 - Category: Emitter
 - Function name: `Plugin.Assets()`.
-- Source: [`quartz/plugins/emitters/assets.ts`](https://github.com/jackyzha0/quartz/blob/v4/quartz/plugins/emitters/assets.ts).
+- Source: [`quartz/plugins/emitters/assets.ts`](https://github.com/jackyzha0/quartz/blob/v5/quartz/plugins/emitters/assets.ts).

docs/plugins/CNAME.md

@@ -18,5 +18,6 @@ This plugin has no configuration options.
 ## API
 
 - Category: Emitter
-- Function name: `Plugin.CNAME()`.
+- Function name: `ExternalPlugin.CNAME()`.
-- Source: [`quartz/plugins/emitters/cname.ts`](https://github.com/jackyzha0/quartz/blob/v4/quartz/plugins/emitters/cname.ts).
+- Source: [`quartz-community/cname`](https://github.com/quartz-community/cname)
+- Install: `npx quartz plugin add github:quartz-community/cname`

docs/plugins/Citations.md

@@ -20,5 +20,6 @@ This plugin accepts the following configuration options:
 ## API
 
 - Category: Transformer
-- Function name: `Plugin.Citations()`.
+- Function name: `ExternalPlugin.Citations()`.
-- Source: [`quartz/plugins/transformers/citations.ts`](https://github.com/jackyzha0/quartz/blob/v4/quartz/plugins/transformers/citations.ts).
+- Source: [`quartz-community/citations`](https://github.com/quartz-community/citations)
+- Install: `npx quartz plugin add github:quartz-community/citations`

docs/plugins/ComponentResources.md

@@ -15,4 +15,4 @@ This plugin has no configuration options.
 
 - Category: Emitter
 - Function name: `Plugin.ComponentResources()`.
-- Source: [`quartz/plugins/emitters/componentResources.ts`](https://github.com/jackyzha0/quartz/blob/v4/quartz/plugins/emitters/componentResources.ts).
+- Source: [`quartz/plugins/emitters/componentResources.ts`](https://github.com/jackyzha0/quartz/blob/v5/quartz/plugins/emitters/componentResources.ts).

docs/plugins/ContentIndex.md

@@ -23,5 +23,6 @@ This plugin accepts the following configuration options:
 ## API
 
 - Category: Emitter
-- Function name: `Plugin.ContentIndex()`.
+- Function name: `ExternalPlugin.ContentIndex()`.
-- Source: [`quartz/plugins/emitters/contentIndex.ts`](https://github.com/jackyzha0/quartz/blob/v4/quartz/plugins/emitters/contentIndex.ts).
+- Source: [`quartz-community/content-index`](https://github.com/quartz-community/content-index)
+- Install: `npx quartz plugin add github:quartz-community/content-index`

docs/plugins/ContentPage.md

@@ -1,10 +1,10 @@
 ---
 title: ContentPage
 tags:
-  - plugin/emitter
+  - plugin/pageType
 ---
 
-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.
+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 is now configured in the `pageTypes` section of `quartz.config.ts`.
 
 > [!note]
 > For information on how to add, remove or configure plugins, see the [[configuration#Plugins|Configuration]] page.
@@ -13,6 +13,7 @@ This plugin has no configuration options.
 
 ## API
 
-- Category: Emitter
+- Category: Page Type
-- Function name: `Plugin.ContentPage()`.
+- Function name: `ExternalPlugin.ContentPage()`.
-- Source: [`quartz/plugins/emitters/contentPage.tsx`](https://github.com/jackyzha0/quartz/blob/v4/quartz/plugins/emitters/contentPage.tsx).
+- Source: [`quartz-community/content-page`](https://github.com/quartz-community/content-page)
+- Install: `npx quartz plugin add github:quartz-community/content-page`

docs/plugins/CrawlLinks.md

@@ -26,5 +26,6 @@ This plugin accepts the following configuration options:
 ## API
 
 - Category: Transformer
-- Function name: `Plugin.CrawlLinks()`.
+- Function name: `ExternalPlugin.CrawlLinks()`.
-- Source: [`quartz/plugins/transformers/links.ts`](https://github.com/jackyzha0/quartz/blob/v4/quartz/plugins/transformers/links.ts).
+- Source: [`quartz-community/crawl-links`](https://github.com/quartz-community/crawl-links)
+- Install: `npx quartz plugin add github:quartz-community/crawl-links`

docs/plugins/CreatedModifiedDate.md

@@ -23,5 +23,6 @@ When loading the frontmatter, the value of [[Frontmatter#List]] is used.
 ## API
 
 - Category: Transformer
-- Function name: `Plugin.CreatedModifiedDate()`.
+- Function name: `ExternalPlugin.CreatedModifiedDate()`.
-- Source: [`quartz/plugins/transformers/lastmod.ts`](https://github.com/jackyzha0/quartz/blob/v4/quartz/plugins/transformers/lastmod.ts).
+- Source: [`quartz-community/created-modified-date`](https://github.com/quartz-community/created-modified-date)
+- Install: `npx quartz plugin add github:quartz-community/created-modified-date`

docs/plugins/CustomOgImages.md

@@ -358,3 +358,10 @@ export const og: SocialImageOptions["Component"] = (
   )
 }
 ```
+
+## API
+
+- Category: Emitter
+- Function name: `ExternalPlugin.CustomOgImages()`.
+- Source: [`quartz-community/og-image`](https://github.com/quartz-community/og-image)
+- Install: `npx quartz plugin add github:quartz-community/og-image`

docs/plugins/Description.md

@@ -19,5 +19,6 @@ This plugin accepts the following configuration options:
 ## API
 
 - Category: Transformer
-- Function name: `Plugin.Description()`.
+- Function name: `ExternalPlugin.Description()`.
-- Source: [`quartz/plugins/transformers/description.ts`](https://github.com/jackyzha0/quartz/blob/v4/quartz/plugins/transformers/description.ts).
+- Source: [`quartz-community/description`](https://github.com/quartz-community/description)
+- Install: `npx quartz plugin add github:quartz-community/description`

docs/plugins/ExplicitPublish.md

@@ -14,5 +14,6 @@ This plugin has no configuration options.
 ## API
 
 - Category: Filter
-- Function name: `Plugin.ExplicitPublish()`.
+- Function name: `ExternalPlugin.ExplicitPublish()`.
-- Source: [`quartz/plugins/filters/explicit.ts`](https://github.com/jackyzha0/quartz/blob/v4/quartz/plugins/filters/explicit.ts).
+- Source: [`quartz-community/explicit-publish`](https://github.com/quartz-community/explicit-publish)
+- Install: `npx quartz plugin add github:quartz-community/explicit-publish`

docs/plugins/Favicon.md

@@ -15,5 +15,6 @@ This plugin has no configuration options.
 ## API
 
 - Category: Emitter
-- Function name: `Plugin.Favicon()`.
+- Function name: `ExternalPlugin.Favicon()`.
-- Source: [`quartz/plugins/emitters/favicon.ts`](https://github.com/jackyzha0/quartz/blob/v4/quartz/plugins/emitters/favicon.ts).
+- Source: [`quartz-community/favicon`](https://github.com/quartz-community/favicon)
+- Install: `npx quartz plugin add github:quartz-community/favicon`

docs/plugins/FolderPage.md

@@ -1,24 +1,23 @@
 ---
 title: FolderPage
 tags:
-  - plugin/emitter
+  - plugin/pageType
 ---
 
-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.
+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. 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
+- Category: Page Type
-- Function name: `Plugin.FolderPage()`.
+- Function name: `ExternalPlugin.FolderPage()`.
-- Source: [`quartz/plugins/emitters/folderPage.tsx`](https://github.com/jackyzha0/quartz/blob/v4/quartz/plugins/emitters/folderPage.tsx).
+- Source: [`quartz-community/folder-page`](https://github.com/quartz-community/folder-page)
+- Install: `npx quartz plugin add github:quartz-community/folder-page`

docs/plugins/Frontmatter.md

@@ -69,4 +69,4 @@ Quartz supports the following frontmatter:
 
 - Category: Transformer
 - Function name: `Plugin.Frontmatter()`.
-- Source: [`quartz/plugins/transformers/frontmatter.ts`](https://github.com/jackyzha0/quartz/blob/v4/quartz/plugins/transformers/frontmatter.ts).
+- Source: [`quartz/plugins/transformers/frontmatter.ts`](https://github.com/jackyzha0/quartz/blob/v5/quartz/plugins/transformers/frontmatter.ts).

docs/plugins/GitHubFlavoredMarkdown.md

@@ -19,5 +19,6 @@ This plugin accepts the following configuration options:
 ## API
 
 - Category: Transformer
-- Function name: `Plugin.GitHubFlavoredMarkdown()`.
+- Function name: `ExternalPlugin.GitHubFlavoredMarkdown()`.
-- Source: [`quartz/plugins/transformers/gfm.ts`](https://github.com/jackyzha0/quartz/blob/v4/quartz/plugins/transformers/gfm.ts).
+- Source: [`quartz-community/github-flavored-markdown`](https://github.com/quartz-community/github-flavored-markdown)
+- Install: `npx quartz plugin add github:quartz-community/github-flavored-markdown`

docs/plugins/HardLineBreaks.md

@@ -14,5 +14,6 @@ This plugin has no configuration options.
 ## API
 
 - Category: Transformer
-- Function name: `Plugin.HardLineBreaks()`.
+- Function name: `ExternalPlugin.HardLineBreaks()`.
-- Source: [`quartz/plugins/transformers/linebreaks.ts`](https://github.com/jackyzha0/quartz/blob/v4/quartz/plugins/transformers/linebreaks.ts).
+- Source: [`quartz-community/hard-line-breaks`](https://github.com/quartz-community/hard-line-breaks)
+- Install: `npx quartz plugin add github:quartz-community/hard-line-breaks`

docs/plugins/Latex.md

@@ -17,5 +17,6 @@ This plugin accepts the following configuration options:
 ## API
 
 - Category: Transformer
-- Function name: `Plugin.Latex()`.
+- Function name: `ExternalPlugin.Latex()`.
-- Source: [`quartz/plugins/transformers/latex.ts`](https://github.com/jackyzha0/quartz/blob/v4/quartz/plugins/transformers/latex.ts).
+- Source: [`quartz-community/latex`](https://github.com/quartz-community/latex)
+- Install: `npx quartz plugin add github:quartz-community/latex`

docs/plugins/NotFoundPage.md

@@ -1,7 +1,7 @@
 ---
 title: NotFoundPage
 tags:
-  - plugin/emitter
+  - plugin/pageType
 ---
 
 This plugin emits a 404 (Not Found) page for broken or non-existent URLs.
@@ -13,6 +13,6 @@ This plugin has no configuration options.
 
 ## API
 
-- Category: Emitter
+- Category: Page Type
-- Function name: `Plugin.NotFoundPage()`.
+- Function name: `Plugin.PageTypes.NotFoundPageType()`.
-- Source: [`quartz/plugins/emitters/404.tsx`](https://github.com/jackyzha0/quartz/blob/v4/quartz/plugins/emitters/404.tsx).
+- Source: [`quartz/plugins/emitters/404.tsx`](https://github.com/jackyzha0/quartz/blob/v5/quartz/plugins/emitters/404.tsx).

docs/plugins/ObsidianFlavoredMarkdown.md

@@ -31,5 +31,6 @@ This plugin accepts the following configuration options:
 ## API
 
 - Category: Transformer
-- Function name: `Plugin.ObsidianFlavoredMarkdown()`.
+- Function name: `ExternalPlugin.ObsidianFlavoredMarkdown()`.
-- Source: [`quartz/plugins/transformers/ofm.ts`](https://github.com/jackyzha0/quartz/blob/v4/quartz/plugins/transformers/ofm.ts)
+- Source: [`quartz-community/obsidian-flavored-markdown`](https://github.com/quartz-community/obsidian-flavored-markdown)
+- Install: `npx quartz plugin add github:quartz-community/obsidian-flavored-markdown`

docs/plugins/OxHugoFlavoredMarkdown.md

@@ -25,5 +25,6 @@ This plugin accepts the following configuration options:
 ## API
 
 - Category: Transformer
-- Function name: `Plugin.OxHugoFlavoredMarkdown()`.
+- Function name: `ExternalPlugin.OxHugoFlavoredMarkdown()`.
-- Source: [`quartz/plugins/transformers/oxhugofm.ts`](https://github.com/jackyzha0/quartz/blob/v4/quartz/plugins/transformers/oxhugofm.ts).
+- Source: [`quartz-community/ox-hugo`](https://github.com/quartz-community/ox-hugo)
+- Install: `npx quartz plugin add github:quartz-community/ox-hugo`

docs/plugins/RemoveDrafts.md

@@ -14,5 +14,6 @@ This plugin has no configuration options.
 ## API
 
 - Category: Filter
-- Function name: `Plugin.RemoveDrafts()`.
+- Function name: `ExternalPlugin.RemoveDrafts()`.
-- Source: [`quartz/plugins/filters/draft.ts`](https://github.com/jackyzha0/quartz/blob/v4/quartz/plugins/filters/draft.ts).
+- Source: [`quartz-community/remove-draft`](https://github.com/quartz-community/remove-draft)
+- Install: `npx quartz plugin add github:quartz-community/remove-draft`

docs/plugins/RoamFlavoredMarkdown.md

@@ -22,5 +22,6 @@ This plugin accepts the following configuration options:
 ## API
 
 - Category: Transformer
-- Function name: `Plugin.RoamFlavoredMarkdown()`.
+- Function name: `ExternalPlugin.RoamFlavoredMarkdown()`.
-- Source: [`quartz/plugins/transformers/roam.ts`](https://github.com/jackyzha0/quartz/blob/v4/quartz/plugins/transformers/roam.ts).
+- Source: [`quartz-community/roam`](https://github.com/quartz-community/roam)
+- Install: `npx quartz plugin add github:quartz-community/roam`

docs/plugins/Static.md

@@ -18,4 +18,4 @@ This plugin has no configuration options.
 
 - Category: Emitter
 - Function name: `Plugin.Static()`.
-- Source: [`quartz/plugins/emitters/static.ts`](https://github.com/jackyzha0/quartz/blob/v4/quartz/plugins/emitters/static.ts).
+- Source: [`quartz/plugins/emitters/static.ts`](https://github.com/jackyzha0/quartz/blob/v5/quartz/plugins/emitters/static.ts).

docs/plugins/SyntaxHighlighting.md

@@ -19,5 +19,6 @@ In addition, you can further override the colours in the `quartz/styles/syntax.s
 ## API
 
 - Category: Transformer
-- Function name: `Plugin.SyntaxHighlighting()`.
+- Function name: `ExternalPlugin.SyntaxHighlighting()`.
-- Source: [`quartz/plugins/transformers/syntax.ts`](https://github.com/jackyzha0/quartz/blob/v4/quartz/plugins/transformers/syntax.ts).
+- Source: [`quartz-community/syntax-highlighting`](https://github.com/quartz-community/syntax-highlighting)
+- Install: `npx quartz plugin add github:quartz-community/syntax-highlighting`

docs/plugins/TableOfContents.md

@@ -22,5 +22,6 @@ This plugin accepts the following configuration options:
 ## API
 
 - Category: Transformer
-- Function name: `Plugin.TableOfContents()`.
+- Function name: `ExternalPlugin.TableOfContentsTransformer()`.
-- Source: [`quartz/plugins/transformers/toc.ts`](https://github.com/jackyzha0/quartz/blob/v4/quartz/plugins/transformers/toc.ts).
+- Source: [`quartz-community/table-of-contents`](https://github.com/quartz-community/table-of-contents)
+- Install: `npx quartz plugin add github:quartz-community/table-of-contents`

docs/plugins/TagPage.md

@@ -1,22 +1,21 @@
 ---
 title: TagPage
 tags:
-  - plugin/emitter
+  - plugin/pageType
 ---
 
-This plugin emits dedicated pages for each tag used in the content. See [[folder and tag listings]] for more information.
+This plugin is a page type plugin that 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
+- Category: Page Type
-- Function name: `Plugin.TagPage()`.
+- Function name: `ExternalPlugin.TagPage()`.
-- Source: [`quartz/plugins/emitters/tagPage.tsx`](https://github.com/jackyzha0/quartz/blob/v4/quartz/plugins/emitters/tagPage.tsx).
+- Source: [`quartz-community/tag-page`](https://github.com/quartz-community/tag-page)
+- Install: `npx quartz plugin add github:quartz-community/tag-page`