diff --git a/docs/Base.base b/docs/Base.base index bc878a40a..beb5172e1 100644 --- a/docs/Base.base +++ b/docs/Base.base @@ -122,3 +122,14 @@ views: - formula.section - formula.last_modified limit: 24 + - type: cards + name: Image Cards + filters: + and: + - file.folder == "plugins" + - "!image.isEmpty()" + order: + - file.name + image: note.image + cardSize: 220 + imageAspectRatio: 1 diff --git a/docs/plugins/AliasRedirects.md b/docs/plugins/AliasRedirects.md index f8a48fd83..be1c39808 100644 --- a/docs/plugins/AliasRedirects.md +++ b/docs/plugins/AliasRedirects.md @@ -2,6 +2,7 @@ title: AliasRedirects tags: - plugin/emitter +image: https://images.unsplash.com/photo-1601735479770-bb5de9dbe844 --- This plugin emits HTML redirect pages for aliases and permalinks defined in the frontmatter of content files. diff --git a/docs/plugins/ArticleTitle.md b/docs/plugins/ArticleTitle.md index 742377520..1b254ffd5 100644 --- a/docs/plugins/ArticleTitle.md +++ b/docs/plugins/ArticleTitle.md @@ -2,6 +2,7 @@ title: ArticleTitle tags: - plugin/component +image: --- This plugin renders the article title from the page's frontmatter as an `

` heading at the top of the page content. It reads the `title` field from frontmatter (falling back to the filename if no title is set). diff --git a/docs/plugins/Assets.md b/docs/plugins/Assets.md index 6915a4926..57b41d849 100644 --- a/docs/plugins/Assets.md +++ b/docs/plugins/Assets.md @@ -2,6 +2,7 @@ title: Assets tags: - plugin/emitter +image: https://images.unsplash.com/photo-1526304640581-d334cdbbf45e --- 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]]. diff --git a/docs/plugins/Backlinks.md b/docs/plugins/Backlinks.md index 78c13aa38..94f031772 100644 --- a/docs/plugins/Backlinks.md +++ b/docs/plugins/Backlinks.md @@ -2,6 +2,7 @@ title: Backlinks tags: - plugin/component +image: --- Shows pages that link to the current page. diff --git a/docs/plugins/BasesPage.md b/docs/plugins/BasesPage.md index e195fe524..676163e80 100644 --- a/docs/plugins/BasesPage.md +++ b/docs/plugins/BasesPage.md @@ -3,6 +3,7 @@ title: BasesPage tags: - plugin/pageType - plugin/component +image: --- This plugin provides support for [Obsidian Bases](https://obsidian.md/changelog/2025-04-15-desktop-v1.8.0/) (`.base` files) in Quartz. It reads `.base` files from your vault, resolves matching notes based on the query definition, and renders them as interactive database-like views with support for tables, lists, cards, and maps. It uses the `default` [[layout#Page Frames|page frame]] (three-column layout with sidebars). diff --git a/docs/plugins/Breadcrumbs.md b/docs/plugins/Breadcrumbs.md index 3f41aa0a1..5bf13dd67 100644 --- a/docs/plugins/Breadcrumbs.md +++ b/docs/plugins/Breadcrumbs.md @@ -2,6 +2,7 @@ title: Breadcrumbs tags: - plugin/component +image: --- Navigation breadcrumb trail. diff --git a/docs/plugins/CNAME.md b/docs/plugins/CNAME.md index a84d1b750..d728ee068 100644 --- a/docs/plugins/CNAME.md +++ b/docs/plugins/CNAME.md @@ -2,6 +2,7 @@ title: CNAME tags: - plugin/emitter +image: --- This plugin emits a `CNAME` record that points your subdomain to the default domain of your site. diff --git a/docs/plugins/CanvasPage.md b/docs/plugins/CanvasPage.md index 3bbea0b3a..bfe966018 100644 --- a/docs/plugins/CanvasPage.md +++ b/docs/plugins/CanvasPage.md @@ -2,6 +2,7 @@ title: CanvasPage tags: - plugin/pageType +image: "#7852ee" --- This plugin is a page type plugin that renders [JSON Canvas](https://jsoncanvas.org) (`.canvas`) files as interactive, pannable and zoomable canvas pages. It uses a custom `"canvas"` [[layout#Page Frames|page frame]] that provides a fullscreen, always-on canvas experience with a togglable left sidebar for navigation. It supports the full [JSON Canvas 1.0 spec](https://jsoncanvas.org/spec/1.0/), including text nodes with Markdown rendering, file nodes that link to other pages in your vault, link nodes for external URLs, and group nodes for visual organization. Edges between nodes are rendered as SVG paths with optional labels, arrow markers, and colors. diff --git a/docs/plugins/Citations.md b/docs/plugins/Citations.md index 9a207ccad..f4125e9a5 100644 --- a/docs/plugins/Citations.md +++ b/docs/plugins/Citations.md @@ -1,7 +1,8 @@ --- -title: "Citations" +title: Citations tags: - plugin/transformer +image: https://images.unsplash.com/photo-1582079133805-43655f026448 --- This plugin adds Citation support to Quartz. diff --git a/docs/plugins/Comments.md b/docs/plugins/Comments.md index e2a127e73..b5f5bfc0b 100644 --- a/docs/plugins/Comments.md +++ b/docs/plugins/Comments.md @@ -2,6 +2,7 @@ title: Comments tags: - plugin/component +image: "[[giscus-results.png]]" --- Comment system (giscus, utterances, etc.). diff --git a/docs/plugins/ComponentResources.md b/docs/plugins/ComponentResources.md index 71625691e..3d60c843a 100644 --- a/docs/plugins/ComponentResources.md +++ b/docs/plugins/ComponentResources.md @@ -2,6 +2,7 @@ title: ComponentResources tags: - plugin/emitter +image: --- 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]]. diff --git a/docs/plugins/ContentIndex.md b/docs/plugins/ContentIndex.md index a7b560a6e..91f82fe76 100644 --- a/docs/plugins/ContentIndex.md +++ b/docs/plugins/ContentIndex.md @@ -2,6 +2,7 @@ title: ContentIndex tags: - plugin/emitter +image: --- 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. diff --git a/docs/plugins/ContentMeta.md b/docs/plugins/ContentMeta.md index 0a5ff943a..93b5c587f 100644 --- a/docs/plugins/ContentMeta.md +++ b/docs/plugins/ContentMeta.md @@ -2,6 +2,7 @@ title: ContentMeta tags: - plugin/component +image: --- This plugin displays content metadata below the article title, such as the creation date and estimated reading time. diff --git a/docs/plugins/ContentPage.md b/docs/plugins/ContentPage.md index 7e71d20ae..a5626bd7b 100644 --- a/docs/plugins/ContentPage.md +++ b/docs/plugins/ContentPage.md @@ -2,6 +2,7 @@ title: ContentPage tags: - plugin/pageType +image: --- 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 uses the `default` [[layout#Page Frames|page frame]] (three-column layout with sidebars). It is now configured in the `pageTypes` section of `quartz.config.yaml`. diff --git a/docs/plugins/CrawlLinks.md b/docs/plugins/CrawlLinks.md index 3c5aa281a..badf1d4a2 100644 --- a/docs/plugins/CrawlLinks.md +++ b/docs/plugins/CrawlLinks.md @@ -2,6 +2,7 @@ title: CrawlLinks tags: - plugin/transformer +image: --- 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. diff --git a/docs/plugins/CreatedModifiedDate.md b/docs/plugins/CreatedModifiedDate.md index ba04e9531..0fd8275c9 100644 --- a/docs/plugins/CreatedModifiedDate.md +++ b/docs/plugins/CreatedModifiedDate.md @@ -1,7 +1,8 @@ --- -title: "CreatedModifiedDate" +title: CreatedModifiedDate tags: - plugin/transformer +image: --- 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. diff --git a/docs/plugins/CustomOgImages.md b/docs/plugins/CustomOgImages.md index 570e16db3..153424b6b 100644 --- a/docs/plugins/CustomOgImages.md +++ b/docs/plugins/CustomOgImages.md @@ -2,6 +2,7 @@ title: Custom OG Images tags: - feature/emitter +image: "[[social-image-preview-dark.png]]" --- The Custom OG Images emitter plugin generates social media preview images for your pages. It uses [satori](https://github.com/vercel/satori) to convert HTML/CSS into images, allowing you to create beautiful and consistent social media preview cards for your content. diff --git a/docs/plugins/Darkmode.md b/docs/plugins/Darkmode.md index 1e9e372f8..d0e9c3d80 100644 --- a/docs/plugins/Darkmode.md +++ b/docs/plugins/Darkmode.md @@ -2,6 +2,7 @@ title: Darkmode tags: - plugin/component +image: "#0052cc" --- Dark mode toggle. diff --git a/docs/plugins/Description.md b/docs/plugins/Description.md index a2d79591c..7c8a2b425 100644 --- a/docs/plugins/Description.md +++ b/docs/plugins/Description.md @@ -2,6 +2,7 @@ title: Description tags: - plugin/transformer +image: --- 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. diff --git a/docs/plugins/EncryptedPages Demo.md b/docs/plugins/EncryptedPages Demo.md index 011ac31fb..4ad31a322 100644 --- a/docs/plugins/EncryptedPages Demo.md +++ b/docs/plugins/EncryptedPages Demo.md @@ -3,6 +3,7 @@ title: Encrypted Pages Demo password: quartz tags: - plugin/transformer +image: --- Congratulations! You've successfully decrypted this page. 🎉 diff --git a/docs/plugins/EncryptedPages.md b/docs/plugins/EncryptedPages.md index 667193955..bec3c6d38 100644 --- a/docs/plugins/EncryptedPages.md +++ b/docs/plugins/EncryptedPages.md @@ -3,6 +3,7 @@ title: EncryptedPages tags: - plugin/transformer - plugin/filter +image: "#FF1493" --- Password-protected encrypted pages. Encrypts page content at build time using AES-256-GCM and decrypts client-side with the Web Crypto API. Passwords are set per-page via frontmatter. diff --git a/docs/plugins/ExplicitPublish.md b/docs/plugins/ExplicitPublish.md index 42aae3b52..33e97acb0 100644 --- a/docs/plugins/ExplicitPublish.md +++ b/docs/plugins/ExplicitPublish.md @@ -2,6 +2,7 @@ title: ExplicitPublish tags: - plugin/filter +image: --- 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. diff --git a/docs/plugins/Explorer.md b/docs/plugins/Explorer.md index 66a8ea4a5..cce7fc87b 100644 --- a/docs/plugins/Explorer.md +++ b/docs/plugins/Explorer.md @@ -2,6 +2,7 @@ title: Explorer tags: - plugin/component +image: --- File tree explorer sidebar. diff --git a/docs/plugins/Favicon.md b/docs/plugins/Favicon.md index 488f6b562..977ab4f6f 100644 --- a/docs/plugins/Favicon.md +++ b/docs/plugins/Favicon.md @@ -2,6 +2,7 @@ title: Favicon tags: - plugin/emitter +image: --- This plugin emits a `favicon.ico` into the `public` folder. It creates the favicon from `icon.png` located in the `quartz/static` folder. diff --git a/docs/plugins/FolderPage.md b/docs/plugins/FolderPage.md index 9bf5aa44d..cc88fa87e 100644 --- a/docs/plugins/FolderPage.md +++ b/docs/plugins/FolderPage.md @@ -2,6 +2,7 @@ title: FolderPage tags: - plugin/pageType +image: --- 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. It uses the `default` [[layout#Page Frames|page frame]] (three-column layout with sidebars). See [[folder and tag listings]] for more information. diff --git a/docs/plugins/Footer.md b/docs/plugins/Footer.md index b57027447..d3e54b4bf 100644 --- a/docs/plugins/Footer.md +++ b/docs/plugins/Footer.md @@ -2,6 +2,7 @@ title: Footer tags: - plugin/component +image: --- This plugin renders a footer at the bottom of the page with a "Created with Quartz" message and a set of configurable links. diff --git a/docs/plugins/Frontmatter.md b/docs/plugins/Frontmatter.md index 73ce92809..3c2e42951 100644 --- a/docs/plugins/Frontmatter.md +++ b/docs/plugins/Frontmatter.md @@ -1,14 +1,15 @@ --- -title: "Frontmatter" +title: Frontmatter aliases: - note-properties - Note Properties -description: "Parses frontmatter and displays note properties in a collapsible panel." +description: Parses frontmatter and displays note properties in a collapsible panel. tags: - plugin/transformer - plugin/component publish: true enableToc: true +image: --- This plugin parses the frontmatter of the page using the [gray-matter](https://github.com/jonschlinkert/gray-matter) library and optionally displays selected properties in a collapsible panel. See [[authoring content#Syntax]], [[Obsidian compatibility]] and [[OxHugo compatibility]] for more information. diff --git a/docs/plugins/GitHubFlavoredMarkdown.md b/docs/plugins/GitHubFlavoredMarkdown.md index 00b62edeb..dc23a03ee 100644 --- a/docs/plugins/GitHubFlavoredMarkdown.md +++ b/docs/plugins/GitHubFlavoredMarkdown.md @@ -2,6 +2,7 @@ title: GitHubFlavoredMarkdown tags: - plugin/transformer +image: --- This plugin enhances Markdown processing to support GitHub Flavored Markdown (GFM) which adds features like autolink literals, footnotes, strikethrough, tables and tasklists. diff --git a/docs/plugins/Graph.md b/docs/plugins/Graph.md index 54e1de8a5..54b1e6f48 100644 --- a/docs/plugins/Graph.md +++ b/docs/plugins/Graph.md @@ -2,6 +2,7 @@ title: Graph tags: - plugin/component +image: --- Interactive graph visualization. diff --git a/docs/plugins/HardLineBreaks.md b/docs/plugins/HardLineBreaks.md index 8ff56f0ef..40303ba8b 100644 --- a/docs/plugins/HardLineBreaks.md +++ b/docs/plugins/HardLineBreaks.md @@ -2,6 +2,7 @@ title: HardLineBreaks tags: - plugin/transformer +image: "#ff8000" --- 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]]. diff --git a/docs/plugins/Latex.md b/docs/plugins/Latex.md index 96ab855c8..b3b304f1c 100644 --- a/docs/plugins/Latex.md +++ b/docs/plugins/Latex.md @@ -1,7 +1,8 @@ --- -title: "Latex" +title: Latex tags: - plugin/transformer +image: --- This plugin adds LaTeX support to Quartz. See [[features/Latex|Latex]] for more information. diff --git a/docs/plugins/NotFoundPage.md b/docs/plugins/NotFoundPage.md index a881e9f6c..bb496978f 100644 --- a/docs/plugins/NotFoundPage.md +++ b/docs/plugins/NotFoundPage.md @@ -2,6 +2,7 @@ title: NotFoundPage tags: - plugin/pageType +image: --- This plugin emits a 404 (Not Found) page for broken or non-existent URLs. It uses the `minimal` [[layout#Page Frames|page frame]] (no sidebars, no header or beforeBody chrome — only content and footer) to present a clean error page. diff --git a/docs/plugins/NoteProperties.md b/docs/plugins/NoteProperties.md index 29dd55f37..e2abb35f0 100644 --- a/docs/plugins/NoteProperties.md +++ b/docs/plugins/NoteProperties.md @@ -2,6 +2,7 @@ title: NoteProperties tags: - plugin/component +image: --- The NoteProperties plugin is documented under [[Frontmatter]]. diff --git a/docs/plugins/ObsidianFlavoredMarkdown.md b/docs/plugins/ObsidianFlavoredMarkdown.md index a67a048d4..d0e1ab8bd 100644 --- a/docs/plugins/ObsidianFlavoredMarkdown.md +++ b/docs/plugins/ObsidianFlavoredMarkdown.md @@ -2,6 +2,7 @@ title: ObsidianFlavoredMarkdown tags: - plugin/transformer +image: --- This plugin provides support for [[Obsidian compatibility]]. diff --git a/docs/plugins/OxHugoFlavoredMarkdown.md b/docs/plugins/OxHugoFlavoredMarkdown.md index 8770b35e1..97411d4ec 100644 --- a/docs/plugins/OxHugoFlavoredMarkdown.md +++ b/docs/plugins/OxHugoFlavoredMarkdown.md @@ -2,6 +2,7 @@ title: OxHugoFlavoredMarkdown tags: - plugin/transformer +image: --- This plugin provides support for [ox-hugo](https://github.com/kaushalmodi/ox-hugo) compatibility. See [[OxHugo compatibility]] for more information. diff --git a/docs/plugins/PageTitle.md b/docs/plugins/PageTitle.md index b9c228fd5..e3a4f02cd 100644 --- a/docs/plugins/PageTitle.md +++ b/docs/plugins/PageTitle.md @@ -2,6 +2,7 @@ title: PageTitle tags: - plugin/component +image: --- This plugin renders the site-wide page title (configured via the `pageTitle` field in [[configuration]]) as a clickable link to the home page. It typically appears in the left sidebar. diff --git a/docs/plugins/ReaderMode.md b/docs/plugins/ReaderMode.md index db3671792..dc52ef332 100644 --- a/docs/plugins/ReaderMode.md +++ b/docs/plugins/ReaderMode.md @@ -2,6 +2,7 @@ title: ReaderMode tags: - plugin/component +image: --- Distraction-free reading mode. diff --git a/docs/plugins/RecentNotes.md b/docs/plugins/RecentNotes.md index e7e2dd163..b8761c827 100644 --- a/docs/plugins/RecentNotes.md +++ b/docs/plugins/RecentNotes.md @@ -2,6 +2,7 @@ title: RecentNotes tags: - plugin/component +image: --- Shows recently modified notes. diff --git a/docs/plugins/RemoveDrafts.md b/docs/plugins/RemoveDrafts.md index 32e333452..fdc106d09 100644 --- a/docs/plugins/RemoveDrafts.md +++ b/docs/plugins/RemoveDrafts.md @@ -2,6 +2,7 @@ title: RemoveDrafts tags: - plugin/filter +image: --- 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. diff --git a/docs/plugins/RoamFlavoredMarkdown.md b/docs/plugins/RoamFlavoredMarkdown.md index 7fbe75074..082526a8a 100644 --- a/docs/plugins/RoamFlavoredMarkdown.md +++ b/docs/plugins/RoamFlavoredMarkdown.md @@ -2,6 +2,7 @@ title: RoamFlavoredMarkdown tags: - plugin/transformer +image: --- This plugin provides support for [Roam Research](https://roamresearch.com) compatibility. See [[Roam Research Compatibility]] for more information. diff --git a/docs/plugins/Search.md b/docs/plugins/Search.md index 1155544f2..7ffaaacb0 100644 --- a/docs/plugins/Search.md +++ b/docs/plugins/Search.md @@ -2,6 +2,7 @@ title: Search tags: - plugin/component +image: https://images.unsplash.com/photo-1516382799247-87df95d790b7 --- Full-text search functionality. diff --git a/docs/plugins/Spacer.md b/docs/plugins/Spacer.md index d03932f3c..fff91c206 100644 --- a/docs/plugins/Spacer.md +++ b/docs/plugins/Spacer.md @@ -2,6 +2,7 @@ title: Spacer tags: - plugin/component +image: --- This plugin renders a flexible spacer element that pushes adjacent components apart within a layout group. It uses CSS `flex: 2 1 auto` to fill available space, making it useful for spacing out items in toolbars or sidebars (for example, separating the search bar from the darkmode toggle in the left sidebar toolbar). diff --git a/docs/plugins/StackedPages.md b/docs/plugins/StackedPages.md index b99a8a58e..262f54fab 100644 --- a/docs/plugins/StackedPages.md +++ b/docs/plugins/StackedPages.md @@ -2,6 +2,7 @@ title: StackedPages tags: - plugin/component +image: --- Andy Matuschak-style stacked pages (sliding panes). Clicking internal links opens pages side by side in a horizontal stack, allowing you to trace your path through your notes. Each pane shows a full page and can be individually scrolled or closed. diff --git a/docs/plugins/Static.md b/docs/plugins/Static.md index f1d61c2a0..494e1d885 100644 --- a/docs/plugins/Static.md +++ b/docs/plugins/Static.md @@ -2,6 +2,7 @@ title: Static tags: - plugin/emitter +image: --- 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]]. diff --git a/docs/plugins/SyntaxHighlighting.md b/docs/plugins/SyntaxHighlighting.md index 23287c3a3..657e90ab6 100644 --- a/docs/plugins/SyntaxHighlighting.md +++ b/docs/plugins/SyntaxHighlighting.md @@ -1,7 +1,8 @@ --- -title: "SyntaxHighlighting" +title: SyntaxHighlighting tags: - plugin/transformer +image: https://images.unsplash.com/photo-1580569214296-5cf2bffc5ccd --- This plugin is used to add syntax highlighting to code blocks in Quartz. See [[syntax highlighting]] for more information. diff --git a/docs/plugins/TableOfContents.md b/docs/plugins/TableOfContents.md index 2a849cba7..a75e57fb0 100644 --- a/docs/plugins/TableOfContents.md +++ b/docs/plugins/TableOfContents.md @@ -2,6 +2,7 @@ title: TableOfContents tags: - plugin/transformer +image: https://images.unsplash.com/photo-1768527338896-3765921e992d --- This plugin generates a table of contents (TOC) for Markdown documents. See [[table of contents]] for more information. diff --git a/docs/plugins/TagList.md b/docs/plugins/TagList.md index 93c888a66..cee0a96c2 100644 --- a/docs/plugins/TagList.md +++ b/docs/plugins/TagList.md @@ -2,6 +2,7 @@ title: TagList tags: - plugin/component +image: --- This plugin renders the page's tags as a list of clickable links. Each tag links to its corresponding [[TagPage|tag page]], making it easy for readers to browse related content by topic. diff --git a/docs/plugins/TagPage.md b/docs/plugins/TagPage.md index 4c723d18e..b488dd620 100644 --- a/docs/plugins/TagPage.md +++ b/docs/plugins/TagPage.md @@ -2,6 +2,7 @@ title: TagPage tags: - plugin/pageType +image: --- This plugin is a page type plugin that emits dedicated pages for each tag used in the content. It uses the `default` [[layout#Page Frames|page frame]] (three-column layout with sidebars). See [[folder and tag listings]] for more information. diff --git a/docs/plugins/index.md b/docs/plugins/index.md index 14bfca989..3e9a61f06 100644 --- a/docs/plugins/index.md +++ b/docs/plugins/index.md @@ -1,5 +1,6 @@ --- title: Plugins +image: --- Quartz's functionality is provided by a collection of first-party community plugins. Each plugin can be enabled, disabled, and configured via `quartz.config.yaml`. See [[configuration#Plugins|Configuration]] for details on how to manage plugins.