mirror of
https://github.com/jackyzha0/quartz.git
synced 2026-03-21 21:45:42 -05:00
docs: updated Bases documentation
This commit is contained in:
saberzero1
parent
b4e07a560e
commit
627fa78f19
@ -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
|
||||
|
||||
@ -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.
|
||||
|
||||
@ -2,6 +2,7 @@
|
||||
title: ArticleTitle
|
||||
tags:
|
||||
- plugin/component
|
||||
image:
|
||||
---
|
||||
|
||||
This plugin renders the article title from the page's frontmatter as an `<h1>` 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).
|
||||
|
||||
@ -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]].
|
||||
|
||||
@ -2,6 +2,7 @@
|
||||
title: Backlinks
|
||||
tags:
|
||||
- plugin/component
|
||||
image:
|
||||
---
|
||||
|
||||
Shows pages that link to the current page.
|
||||
|
||||
@ -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).
|
||||
|
||||
@ -2,6 +2,7 @@
|
||||
title: Breadcrumbs
|
||||
tags:
|
||||
- plugin/component
|
||||
image:
|
||||
---
|
||||
|
||||
Navigation breadcrumb trail.
|
||||
|
||||
@ -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.
|
||||
|
||||
@ -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.
|
||||
|
||||
@ -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.
|
||||
|
||||
@ -2,6 +2,7 @@
|
||||
title: Comments
|
||||
tags:
|
||||
- plugin/component
|
||||
image: "[[giscus-results.png]]"
|
||||
---
|
||||
|
||||
Comment system (giscus, utterances, etc.).
|
||||
|
||||
@ -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]].
|
||||
|
||||
@ -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.
|
||||
|
||||
@ -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.
|
||||
|
||||
@ -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`.
|
||||
|
||||
@ -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.
|
||||
|
||||
@ -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.
|
||||
|
||||
@ -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.
|
||||
|
||||
@ -2,6 +2,7 @@
|
||||
title: Darkmode
|
||||
tags:
|
||||
- plugin/component
|
||||
image: "#0052cc"
|
||||
---
|
||||
|
||||
Dark mode toggle.
|
||||
|
||||
@ -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.
|
||||
|
||||
@ -3,6 +3,7 @@ title: Encrypted Pages Demo
|
||||
password: quartz
|
||||
tags:
|
||||
- plugin/transformer
|
||||
image:
|
||||
---
|
||||
|
||||
Congratulations! You've successfully decrypted this page. 🎉
|
||||
|
||||
@ -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.
|
||||
|
||||
@ -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.
|
||||
|
||||
@ -2,6 +2,7 @@
|
||||
title: Explorer
|
||||
tags:
|
||||
- plugin/component
|
||||
image:
|
||||
---
|
||||
|
||||
File tree explorer sidebar.
|
||||
|
||||
@ -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.
|
||||
|
||||
@ -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.
|
||||
|
||||
@ -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.
|
||||
|
||||
@ -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.
|
||||
|
||||
@ -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.
|
||||
|
||||
@ -2,6 +2,7 @@
|
||||
title: Graph
|
||||
tags:
|
||||
- plugin/component
|
||||
image:
|
||||
---
|
||||
|
||||
Interactive graph visualization.
|
||||
|
||||
@ -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]].
|
||||
|
||||
@ -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.
|
||||
|
||||
@ -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.
|
||||
|
||||
@ -2,6 +2,7 @@
|
||||
title: NoteProperties
|
||||
tags:
|
||||
- plugin/component
|
||||
image:
|
||||
---
|
||||
|
||||
The NoteProperties plugin is documented under [[Frontmatter]].
|
||||
|
||||
@ -2,6 +2,7 @@
|
||||
title: ObsidianFlavoredMarkdown
|
||||
tags:
|
||||
- plugin/transformer
|
||||
image:
|
||||
---
|
||||
|
||||
This plugin provides support for [[Obsidian compatibility]].
|
||||
|
||||
@ -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.
|
||||
|
||||
@ -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.
|
||||
|
||||
@ -2,6 +2,7 @@
|
||||
title: ReaderMode
|
||||
tags:
|
||||
- plugin/component
|
||||
image:
|
||||
---
|
||||
|
||||
Distraction-free reading mode.
|
||||
|
||||
@ -2,6 +2,7 @@
|
||||
title: RecentNotes
|
||||
tags:
|
||||
- plugin/component
|
||||
image:
|
||||
---
|
||||
|
||||
Shows recently modified notes.
|
||||
|
||||
@ -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.
|
||||
|
||||
@ -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.
|
||||
|
||||
@ -2,6 +2,7 @@
|
||||
title: Search
|
||||
tags:
|
||||
- plugin/component
|
||||
image: https://images.unsplash.com/photo-1516382799247-87df95d790b7
|
||||
---
|
||||
|
||||
Full-text search functionality.
|
||||
|
||||
@ -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).
|
||||
|
||||
@ -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.
|
||||
|
||||
@ -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]].
|
||||
|
||||
@ -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.
|
||||
|
||||
@ -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.
|
||||
|
||||
@ -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.
|
||||
|
||||
@ -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.
|
||||
|
||||
@ -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.
|
||||
|
||||
Loading…
Reference in New Issue
Block a user