diff --git a/docs/plugins/AliasRedirects.md b/docs/plugins/AliasRedirects.md index 8c0365377..f8a48fd83 100644 --- a/docs/plugins/AliasRedirects.md +++ b/docs/plugins/AliasRedirects.md @@ -33,5 +33,6 @@ 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). +- Function name: `ExternalPlugin.AliasRedirects()`. +- Source: [`quartz-community/alias-redirects`](https://github.com/quartz-community/alias-redirects) +- Install: `npx quartz plugin add github:quartz-community/alias-redirects` diff --git a/docs/plugins/Assets.md b/docs/plugins/Assets.md index 47589b2c3..7daa916ea 100644 --- a/docs/plugins/Assets.md +++ b/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). diff --git a/docs/plugins/CNAME.md b/docs/plugins/CNAME.md index bc12b5acc..a84d1b750 100644 --- a/docs/plugins/CNAME.md +++ b/docs/plugins/CNAME.md @@ -18,5 +18,6 @@ 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). +- Function name: `ExternalPlugin.CNAME()`. +- Source: [`quartz-community/cname`](https://github.com/quartz-community/cname) +- Install: `npx quartz plugin add github:quartz-community/cname` diff --git a/docs/plugins/Citations.md b/docs/plugins/Citations.md index b1a63a037..9a207ccad 100644 --- a/docs/plugins/Citations.md +++ b/docs/plugins/Citations.md @@ -20,5 +20,6 @@ This plugin accepts the following configuration options: ## API - Category: Transformer -- Function name: `Plugin.Citations()`. -- Source: [`quartz/plugins/transformers/citations.ts`](https://github.com/jackyzha0/quartz/blob/v4/quartz/plugins/transformers/citations.ts). +- Function name: `ExternalPlugin.Citations()`. +- Source: [`quartz-community/citations`](https://github.com/quartz-community/citations) +- Install: `npx quartz plugin add github:quartz-community/citations` diff --git a/docs/plugins/ComponentResources.md b/docs/plugins/ComponentResources.md index 6e8c82ef8..504e7e703 100644 --- a/docs/plugins/ComponentResources.md +++ b/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). diff --git a/docs/plugins/ContentIndex.md b/docs/plugins/ContentIndex.md index 037f723bf..a7b560a6e 100644 --- a/docs/plugins/ContentIndex.md +++ b/docs/plugins/ContentIndex.md @@ -23,5 +23,6 @@ This plugin accepts the following configuration options: ## 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). +- Function name: `ExternalPlugin.ContentIndex()`. +- Source: [`quartz-community/content-index`](https://github.com/quartz-community/content-index) +- Install: `npx quartz plugin add github:quartz-community/content-index` diff --git a/docs/plugins/ContentPage.md b/docs/plugins/ContentPage.md index bd33e4ee1..588a1c422 100644 --- a/docs/plugins/ContentPage.md +++ b/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 -- Function name: `Plugin.ContentPage()`. -- Source: [`quartz/plugins/emitters/contentPage.tsx`](https://github.com/jackyzha0/quartz/blob/v4/quartz/plugins/emitters/contentPage.tsx). +- Category: Page Type +- Function name: `ExternalPlugin.ContentPage()`. +- Source: [`quartz-community/content-page`](https://github.com/quartz-community/content-page) +- Install: `npx quartz plugin add github:quartz-community/content-page` diff --git a/docs/plugins/CrawlLinks.md b/docs/plugins/CrawlLinks.md index 47b7bdd77..3c5aa281a 100644 --- a/docs/plugins/CrawlLinks.md +++ b/docs/plugins/CrawlLinks.md @@ -26,5 +26,6 @@ This plugin accepts the following configuration options: ## 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). +- Function name: `ExternalPlugin.CrawlLinks()`. +- Source: [`quartz-community/crawl-links`](https://github.com/quartz-community/crawl-links) +- Install: `npx quartz plugin add github:quartz-community/crawl-links` diff --git a/docs/plugins/CreatedModifiedDate.md b/docs/plugins/CreatedModifiedDate.md index 2d1eaeec1..88123ea06 100644 --- a/docs/plugins/CreatedModifiedDate.md +++ b/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()`. -- Source: [`quartz/plugins/transformers/lastmod.ts`](https://github.com/jackyzha0/quartz/blob/v4/quartz/plugins/transformers/lastmod.ts). +- Function name: `ExternalPlugin.CreatedModifiedDate()`. +- 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` diff --git a/docs/plugins/CustomOgImages.md b/docs/plugins/CustomOgImages.md index 4b5bf0391..7f79b4da7 100644 --- a/docs/plugins/CustomOgImages.md +++ b/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` diff --git a/docs/plugins/Description.md b/docs/plugins/Description.md index af1c8b7c2..a2d79591c 100644 --- a/docs/plugins/Description.md +++ b/docs/plugins/Description.md @@ -19,5 +19,6 @@ This plugin accepts the following configuration options: ## 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). +- Function name: `ExternalPlugin.Description()`. +- Source: [`quartz-community/description`](https://github.com/quartz-community/description) +- Install: `npx quartz plugin add github:quartz-community/description` diff --git a/docs/plugins/ExplicitPublish.md b/docs/plugins/ExplicitPublish.md index 2fd929b92..42aae3b52 100644 --- a/docs/plugins/ExplicitPublish.md +++ b/docs/plugins/ExplicitPublish.md @@ -14,5 +14,6 @@ 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). +- Function name: `ExternalPlugin.ExplicitPublish()`. +- Source: [`quartz-community/explicit-publish`](https://github.com/quartz-community/explicit-publish) +- Install: `npx quartz plugin add github:quartz-community/explicit-publish` diff --git a/docs/plugins/Favicon.md b/docs/plugins/Favicon.md index a6d4d4e1b..488f6b562 100644 --- a/docs/plugins/Favicon.md +++ b/docs/plugins/Favicon.md @@ -15,5 +15,6 @@ This plugin has no configuration options. ## API - Category: Emitter -- Function name: `Plugin.Favicon()`. -- Source: [`quartz/plugins/emitters/favicon.ts`](https://github.com/jackyzha0/quartz/blob/v4/quartz/plugins/emitters/favicon.ts). +- Function name: `ExternalPlugin.Favicon()`. +- Source: [`quartz-community/favicon`](https://github.com/quartz-community/favicon) +- Install: `npx quartz plugin add github:quartz-community/favicon` diff --git a/docs/plugins/FolderPage.md b/docs/plugins/FolderPage.md index 45cfa1574..9763131c4 100644 --- a/docs/plugins/FolderPage.md +++ b/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 -- Function name: `Plugin.FolderPage()`. -- Source: [`quartz/plugins/emitters/folderPage.tsx`](https://github.com/jackyzha0/quartz/blob/v4/quartz/plugins/emitters/folderPage.tsx). +- Category: Page Type +- Function name: `ExternalPlugin.FolderPage()`. +- Source: [`quartz-community/folder-page`](https://github.com/quartz-community/folder-page) +- Install: `npx quartz plugin add github:quartz-community/folder-page` diff --git a/docs/plugins/Frontmatter.md b/docs/plugins/Frontmatter.md index 9dfe53378..bdd222e02 100644 --- a/docs/plugins/Frontmatter.md +++ b/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). diff --git a/docs/plugins/GitHubFlavoredMarkdown.md b/docs/plugins/GitHubFlavoredMarkdown.md index 41fab6b23..00b62edeb 100644 --- a/docs/plugins/GitHubFlavoredMarkdown.md +++ b/docs/plugins/GitHubFlavoredMarkdown.md @@ -19,5 +19,6 @@ This plugin accepts the following configuration options: ## 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). +- Function name: `ExternalPlugin.GitHubFlavoredMarkdown()`. +- 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` diff --git a/docs/plugins/HardLineBreaks.md b/docs/plugins/HardLineBreaks.md index e24f7e129..8ff56f0ef 100644 --- a/docs/plugins/HardLineBreaks.md +++ b/docs/plugins/HardLineBreaks.md @@ -14,5 +14,6 @@ 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). +- Function name: `ExternalPlugin.HardLineBreaks()`. +- 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` diff --git a/docs/plugins/Latex.md b/docs/plugins/Latex.md index eb77db229..96ab855c8 100644 --- a/docs/plugins/Latex.md +++ b/docs/plugins/Latex.md @@ -17,5 +17,6 @@ This plugin accepts the following configuration options: ## 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). +- Function name: `ExternalPlugin.Latex()`. +- Source: [`quartz-community/latex`](https://github.com/quartz-community/latex) +- Install: `npx quartz plugin add github:quartz-community/latex` diff --git a/docs/plugins/NotFoundPage.md b/docs/plugins/NotFoundPage.md index b67994329..7ce612572 100644 --- a/docs/plugins/NotFoundPage.md +++ b/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 -- Function name: `Plugin.NotFoundPage()`. -- Source: [`quartz/plugins/emitters/404.tsx`](https://github.com/jackyzha0/quartz/blob/v4/quartz/plugins/emitters/404.tsx). +- Category: Page Type +- Function name: `Plugin.PageTypes.NotFoundPageType()`. +- Source: [`quartz/plugins/emitters/404.tsx`](https://github.com/jackyzha0/quartz/blob/v5/quartz/plugins/emitters/404.tsx). diff --git a/docs/plugins/ObsidianFlavoredMarkdown.md b/docs/plugins/ObsidianFlavoredMarkdown.md index 277c7720b..8c4d83a35 100644 --- a/docs/plugins/ObsidianFlavoredMarkdown.md +++ b/docs/plugins/ObsidianFlavoredMarkdown.md @@ -31,5 +31,6 @@ This plugin accepts the following configuration options: ## API - Category: Transformer -- Function name: `Plugin.ObsidianFlavoredMarkdown()`. -- Source: [`quartz/plugins/transformers/ofm.ts`](https://github.com/jackyzha0/quartz/blob/v4/quartz/plugins/transformers/ofm.ts) +- Function name: `ExternalPlugin.ObsidianFlavoredMarkdown()`. +- 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` diff --git a/docs/plugins/OxHugoFlavoredMarkdown.md b/docs/plugins/OxHugoFlavoredMarkdown.md index 5c2afeea6..8770b35e1 100644 --- a/docs/plugins/OxHugoFlavoredMarkdown.md +++ b/docs/plugins/OxHugoFlavoredMarkdown.md @@ -25,5 +25,6 @@ This plugin accepts the following configuration options: ## 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). +- Function name: `ExternalPlugin.OxHugoFlavoredMarkdown()`. +- Source: [`quartz-community/ox-hugo`](https://github.com/quartz-community/ox-hugo) +- Install: `npx quartz plugin add github:quartz-community/ox-hugo` diff --git a/docs/plugins/RemoveDrafts.md b/docs/plugins/RemoveDrafts.md index 07fb4d0e4..32e333452 100644 --- a/docs/plugins/RemoveDrafts.md +++ b/docs/plugins/RemoveDrafts.md @@ -14,5 +14,6 @@ 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). +- Function name: `ExternalPlugin.RemoveDrafts()`. +- Source: [`quartz-community/remove-draft`](https://github.com/quartz-community/remove-draft) +- Install: `npx quartz plugin add github:quartz-community/remove-draft` diff --git a/docs/plugins/RoamFlavoredMarkdown.md b/docs/plugins/RoamFlavoredMarkdown.md index 9d89477a2..7fbe75074 100644 --- a/docs/plugins/RoamFlavoredMarkdown.md +++ b/docs/plugins/RoamFlavoredMarkdown.md @@ -22,5 +22,6 @@ This plugin accepts the following configuration options: ## API - Category: Transformer -- Function name: `Plugin.RoamFlavoredMarkdown()`. -- Source: [`quartz/plugins/transformers/roam.ts`](https://github.com/jackyzha0/quartz/blob/v4/quartz/plugins/transformers/roam.ts). +- Function name: `ExternalPlugin.RoamFlavoredMarkdown()`. +- Source: [`quartz-community/roam`](https://github.com/quartz-community/roam) +- Install: `npx quartz plugin add github:quartz-community/roam` diff --git a/docs/plugins/Static.md b/docs/plugins/Static.md index 80bf5a158..604a9c1a9 100644 --- a/docs/plugins/Static.md +++ b/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). diff --git a/docs/plugins/SyntaxHighlighting.md b/docs/plugins/SyntaxHighlighting.md index 6fb67dba0..23287c3a3 100644 --- a/docs/plugins/SyntaxHighlighting.md +++ b/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()`. -- Source: [`quartz/plugins/transformers/syntax.ts`](https://github.com/jackyzha0/quartz/blob/v4/quartz/plugins/transformers/syntax.ts). +- Function name: `ExternalPlugin.SyntaxHighlighting()`. +- Source: [`quartz-community/syntax-highlighting`](https://github.com/quartz-community/syntax-highlighting) +- Install: `npx quartz plugin add github:quartz-community/syntax-highlighting` diff --git a/docs/plugins/TableOfContents.md b/docs/plugins/TableOfContents.md index 0e9e4ea73..35ad223ec 100644 --- a/docs/plugins/TableOfContents.md +++ b/docs/plugins/TableOfContents.md @@ -22,5 +22,6 @@ This plugin accepts the following configuration options: ## 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). +- Function name: `ExternalPlugin.TableOfContentsTransformer()`. +- 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` diff --git a/docs/plugins/TagPage.md b/docs/plugins/TagPage.md index 9556363fe..1cad85fb0 100644 --- a/docs/plugins/TagPage.md +++ b/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 -- Function name: `Plugin.TagPage()`. -- Source: [`quartz/plugins/emitters/tagPage.tsx`](https://github.com/jackyzha0/quartz/blob/v4/quartz/plugins/emitters/tagPage.tsx). +- Category: Page Type +- Function name: `ExternalPlugin.TagPage()`. +- Source: [`quartz-community/tag-page`](https://github.com/quartz-community/tag-page) +- Install: `npx quartz plugin add github:quartz-community/tag-page`