docs: add description frontmatter to all plugin docs for base views

This commit is contained in:
saberzero1
2026-05-24 19:48:32 +02:00
parent cce45e0718
commit cf28741977
43 changed files with 43 additions and 0 deletions

View File

@@ -1,5 +1,6 @@
--- ---
title: AliasRedirects title: AliasRedirects
description: Generates redirect pages from frontmatter aliases.
tags: tags:
- plugin/emitter - plugin/emitter
image: https://images.unsplash.com/photo-1601735479770-bb5de9dbe844 image: https://images.unsplash.com/photo-1601735479770-bb5de9dbe844

View File

@@ -1,5 +1,6 @@
--- ---
title: ArticleTitle title: ArticleTitle
description: Renders the article title as an h1 heading.
tags: tags:
- plugin/component - plugin/component
image: image:

View File

@@ -1,5 +1,6 @@
--- ---
title: Backlinks title: Backlinks
description: Shows pages that link to the current page.
tags: tags:
- plugin/component - plugin/component
image: image:

View File

@@ -1,5 +1,6 @@
--- ---
title: BasesPage title: BasesPage
description: Renders Obsidian Bases files as database-style views.
tags: tags:
- plugin/pageType - plugin/pageType
- plugin/component - plugin/component

View File

@@ -1,5 +1,6 @@
--- ---
title: Breadcrumbs title: Breadcrumbs
description: Breadcrumb navigation trail.
tags: tags:
- plugin/component - plugin/component
image: image:

View File

@@ -1,5 +1,6 @@
--- ---
title: CNAME title: CNAME
description: Emits a CNAME file for custom domain deployment.
tags: tags:
- plugin/emitter - plugin/emitter
image: image:

View File

@@ -1,5 +1,6 @@
--- ---
title: CanvasPage title: CanvasPage
description: Renders JSON Canvas files as interactive, pannable pages.
tags: tags:
- plugin/pageType - plugin/pageType
image: "#7852ee" image: "#7852ee"

View File

@@ -1,5 +1,6 @@
--- ---
title: Citations title: Citations
description: Academic citation and bibliography support via BibTeX.
tags: tags:
- plugin/transformer - plugin/transformer
image: https://images.unsplash.com/photo-1582079133805-43655f026448 image: https://images.unsplash.com/photo-1582079133805-43655f026448

View File

@@ -1,5 +1,6 @@
--- ---
title: Comments title: Comments
description: Comment system integration (Giscus, Utterances, etc.).
tags: tags:
- plugin/component - plugin/component
image: "[[giscus-results.png]]" image: "[[giscus-results.png]]"

View File

@@ -1,5 +1,6 @@
--- ---
title: ContentIndex title: ContentIndex
description: Generates sitemap, RSS feed, and content index.
tags: tags:
- plugin/emitter - plugin/emitter
image: image:

View File

@@ -1,5 +1,6 @@
--- ---
title: ContentMeta title: ContentMeta
description: Displays creation date and reading time.
tags: tags:
- plugin/component - plugin/component
image: image:

View File

@@ -1,5 +1,6 @@
--- ---
title: ContentPage title: ContentPage
description: Generates HTML pages for Markdown content.
tags: tags:
- plugin/pageType - plugin/pageType
image: image:

View File

@@ -1,5 +1,6 @@
--- ---
title: CrawlLinks title: CrawlLinks
description: Parses and resolves internal links. Removing it is not recommended.
tags: tags:
- plugin/transformer - plugin/transformer
image: image:

View File

@@ -1,5 +1,6 @@
--- ---
title: CreatedModifiedDate title: CreatedModifiedDate
description: Determines creation and modification dates from frontmatter, git, or filesystem.
tags: tags:
- plugin/transformer - plugin/transformer
image: image:

View File

@@ -1,5 +1,6 @@
--- ---
title: Custom OG Images title: Custom OG Images
description: Generates Open Graph social preview images.
tags: tags:
- feature/emitter - feature/emitter
image: "[[social-image-preview-dark.png]]" image: "[[social-image-preview-dark.png]]"

View File

@@ -1,5 +1,6 @@
--- ---
title: Darkmode title: Darkmode
description: Toggle between light and dark themes.
tags: tags:
- plugin/component - plugin/component
image: "#0052cc" image: "#0052cc"

View File

@@ -1,5 +1,6 @@
--- ---
title: Description title: Description
description: Generates page descriptions for metadata and previews.
tags: tags:
- plugin/transformer - plugin/transformer
image: image:

View File

@@ -1,5 +1,6 @@
--- ---
title: EncryptedPages title: EncryptedPages
description: Password-protected encrypted pages with shadow content index.
tags: tags:
- plugin/transformer - plugin/transformer
- plugin/emitter - plugin/emitter

View File

@@ -1,5 +1,6 @@
--- ---
title: ExplicitPublish title: ExplicitPublish
description: "Only publishes pages explicitly marked with publish: true."
tags: tags:
- plugin/filter - plugin/filter
image: image:

View File

@@ -1,5 +1,6 @@
--- ---
title: Explorer title: Explorer
description: File tree explorer sidebar.
tags: tags:
- plugin/component - plugin/component
image: image:

View File

@@ -1,5 +1,6 @@
--- ---
title: Favicon title: Favicon
description: Emits the site favicon.
tags: tags:
- plugin/emitter - plugin/emitter
image: image:

View File

@@ -1,5 +1,6 @@
--- ---
title: FolderPage title: FolderPage
description: Generates listing pages for folders.
tags: tags:
- plugin/pageType - plugin/pageType
image: image:

View File

@@ -1,5 +1,6 @@
--- ---
title: Footer title: Footer
description: Page footer with configurable links.
tags: tags:
- plugin/component - plugin/component
image: image:

View File

@@ -1,5 +1,6 @@
--- ---
title: GitHubFlavoredMarkdown title: GitHubFlavoredMarkdown
description: GitHub Flavored Markdown support (tables, task lists, footnotes, strikethrough).
tags: tags:
- plugin/transformer - plugin/transformer
image: image:

View File

@@ -1,5 +1,6 @@
--- ---
title: Graph title: Graph
description: Interactive link graph visualization.
tags: tags:
- plugin/component - plugin/component
image: image:

View File

@@ -1,5 +1,6 @@
--- ---
title: HardLineBreaks title: HardLineBreaks
description: Treats single newlines as hard line breaks.
tags: tags:
- plugin/transformer - plugin/transformer
image: "#ff8000" image: "#ff8000"

View File

@@ -1,5 +1,6 @@
--- ---
title: Latex title: Latex
description: Renders LaTeX math expressions via KaTeX or Typst.
tags: tags:
- plugin/transformer - plugin/transformer
image: image:

View File

@@ -1,5 +1,6 @@
--- ---
title: NoteProperties title: NoteProperties
description: Displays frontmatter properties in a collapsible panel.
tags: tags:
- plugin/component - plugin/component
image: image:

View File

@@ -1,5 +1,6 @@
--- ---
title: ObsidianFlavoredMarkdown title: ObsidianFlavoredMarkdown
description: Obsidian-specific Markdown extensions (wikilinks, callouts, highlights, tags, embeds).
tags: tags:
- plugin/transformer - plugin/transformer
image: image:

View File

@@ -1,5 +1,6 @@
--- ---
title: OxHugoFlavoredMarkdown title: OxHugoFlavoredMarkdown
description: Compatibility for ox-hugo exported Org-mode files.
tags: tags:
- plugin/transformer - plugin/transformer
image: image:

View File

@@ -1,5 +1,6 @@
--- ---
title: PageTitle title: PageTitle
description: Renders the site title as a home link.
tags: tags:
- plugin/component - plugin/component
image: image:

View File

@@ -1,5 +1,6 @@
--- ---
title: ReaderMode title: ReaderMode
description: Distraction-free reading mode toggle.
tags: tags:
- plugin/component - plugin/component
image: image:

View File

@@ -1,5 +1,6 @@
--- ---
title: RecentNotes title: RecentNotes
description: Displays a list of recently modified notes.
tags: tags:
- plugin/component - plugin/component
image: image:

View File

@@ -1,5 +1,6 @@
--- ---
title: RemoveDrafts title: RemoveDrafts
description: Filters out pages marked as drafts.
tags: tags:
- plugin/filter - plugin/filter
image: image:

View File

@@ -1,5 +1,6 @@
--- ---
title: RoamFlavoredMarkdown title: RoamFlavoredMarkdown
description: Compatibility for Roam Research export format.
tags: tags:
- plugin/transformer - plugin/transformer
image: image:

View File

@@ -1,5 +1,6 @@
--- ---
title: Search title: Search
description: Full-text search with tag filtering and keyboard navigation.
tags: tags:
- plugin/component - plugin/component
image: https://images.unsplash.com/photo-1516382799247-87df95d790b7 image: https://images.unsplash.com/photo-1516382799247-87df95d790b7

View File

@@ -1,5 +1,6 @@
--- ---
title: Spacer title: Spacer
description: Flexible spacer for layout groups.
tags: tags:
- plugin/component - plugin/component
image: image:

View File

@@ -1,5 +1,6 @@
--- ---
title: StackedPages title: StackedPages
description: Andy Matuschak-style stacked sliding panes.
tags: tags:
- plugin/component - plugin/component
image: image:

View File

@@ -1,5 +1,6 @@
--- ---
title: SyntaxHighlighting title: SyntaxHighlighting
description: Syntax highlighting for code blocks.
tags: tags:
- plugin/transformer - plugin/transformer
image: https://images.unsplash.com/photo-1580569214296-5cf2bffc5ccd image: https://images.unsplash.com/photo-1580569214296-5cf2bffc5ccd

View File

@@ -1,5 +1,6 @@
--- ---
title: TableOfContents title: TableOfContents
description: Generates and renders a table of contents from headings.
tags: tags:
- plugin/transformer - plugin/transformer
- plugin/component - plugin/component

View File

@@ -1,5 +1,6 @@
--- ---
title: TagList title: TagList
description: Renders tags as clickable links.
tags: tags:
- plugin/component - plugin/component
image: image:

View File

@@ -1,5 +1,6 @@
--- ---
title: TagPage title: TagPage
description: Generates listing pages for tags.
tags: tags:
- plugin/pageType - plugin/pageType
image: image:

View File

@@ -1,5 +1,6 @@
--- ---
title: UnlistedPages title: UnlistedPages
description: Hides pages from navigation and indexes while still publishing them.
tags: tags:
- plugin/transformer - plugin/transformer
image: image: