Riebeckite
Menu
Color mode

Plugins

Plugins add features to a Riebeckite site. Use them when you want more than plain Markdown: Obsidian syntax, search, diagrams, media, SEO, discovery widgets, localization, and diagnostics.

What do you want to do?

Goal Plugin
Use Obsidian WikiLinks and embeds Obsidian Markdown
Show Mermaid diagrams Mermaid
Add site search Search
Use tags and classification pages Taxonomy
Show backlinks Backlinks
Enlarge images in an overlay Lightbox
Show Excalidraw drawings Excalidraw
Show how notes relate to each other ExcaliBrain
Show Obsidian Canvas files Canvas
Use BibTeX citations Citations
Build a multilingual site Localization
Add docs sidebar and previous/next links Docs

This table is an entry point, not the full API reference. For all packages, see the list below.

Add a Plugin

Install the package:

bash
npm install @riebeckite/plugin-search

Register it in the plugins array of riebeckite.config.ts:

ts
import { searchPlugin } from "@riebeckite/plugin-search";
 
export default defineConfig({
  plugins: [searchPlugin()],
});

Each Plugin page shows the package name, import name, and common settings. The package README remains the source of truth for detailed options.

Official Plugins

Each page links to the Plugin reference. Install any Plugin with npm install @riebeckite/plugin-<slug> and register it in riebeckite.config.ts.

Markdown and notes

Plugin What it does
Obsidian Markdown WikiLinks, embeds, callouts, and Obsidian-flavored syntax
Shortcodes Inline, block, and container directives for reusable snippets
Highlight Obsidian-style inline highlighting
Alias Obsidian alias redirects for notes
Properties Frontmatter property panels
Bases Build-time Obsidian Bases tables
Citations BibTeX and BibLaTeX citations
Sidenotes Tufte-style side notes with mobile popovers
Text Fragment Text Fragment links and quotes
Diff Git-backed note diffs and revision history
Daily Notes Daily Note snippet widgets
Flashcards Interactive flashcard decks from code blocks
Kanban Build-time Obsidian Kanban boards
Hover Preview Popover previews for internal links

Diagrams and presentation

Plugin What it does
Mermaid Mermaid diagrams from code blocks
D2 D2 diagrams from code blocks
Graphviz Graphviz DOT graphs
PlantUML PlantUML diagrams from code blocks
Chart.js Chart.js charts from code blocks
Vega-Lite Vega-Lite visualizations from code blocks
WaveDrom WaveDrom timing diagrams
Markmap Markdown mind maps with Markmap
Marp Build-time Marp slide decks
Excalidraw Excalidraw attachment rendering
ExcaliBrain Relationship maps for notes

Visuals and media

Plugin What it does
Attachment Attachment link and embed rendering
Media Audio and video embeds with timestamp fragments
Responsive Image Responsive image markup and lazy loading
Gallery Markdown-driven card galleries
Lightbox Click-to-zoom image lightboxes
PDF Inline PDF attachment viewing
QR Code Inline SVG QR codes from code blocks
Map Interactive and static OpenStreetMap embeds
Rich Embed Build-time rich media embeds
AutoCardLink Link preview cards from cardlink blocks

Code and reading experience

Plugin What it does
Code Enhance Enhanced syntax-highlighted code blocks
Code Tabs Accessible tabbed code blocks
Code Annotations Code annotations, highlights, and diff markers
Table of Contents Scroll-aware in-page table of contents
UX Reading experience enhancements
color-mode Light, dark, and system color-mode switching

Search and navigation

Plugin What it does
Search Client-side full-text search
Navigation Site navigation derived from the vault or authored in config
Backlinks Backlink lists for published notes
Breadcrumbs Slug-hierarchy breadcrumb navigation
Local Graph Local note graph visualizations
Garden Explorer Interactive graph and search explorer
Recent Posts Recent posts lists
Related Posts Build-time related-post navigation
Series Ordered multi-part post navigation
Taxonomy Tag and folder taxonomy, per-term feeds, and SEO
Query Build-time content queries from code blocks
Dataview Build-time Dataview queries
Folder Pages Folder entry pages and generated listings
Archive Monthly archive listing pages

Publishing and SEO

Plugin What it does
SEO Metadata, sitemaps, feeds, and robots.txt
Deploy Static hosting deployment output
Permalink Stable, configurable content permalinks
Rename Rename and move redirects for published notes
Analytics Storage-independent analytics foundation
Changelog Git-backed change history and changelogs
Webmention Verified Webmention receiving and rendering
Share Per-article share links and copy-to-clipboard

Content and developer experience

Plugin What it does
Localization Content localization, localized URLs, and translation metadata
Quality Static quality and accessibility inspection
Diagnostics Content diagnostics for Riebeckite and Obsidian vaults
Docs Docs sidebar and previous/next navigation
Canvas Obsidian Canvas diagram rendering
Discord Embed Discord link preview metadata

If you want to build a Plugin

Start with Writing a Plugin. Exact contracts live in Plugin API, and the framework-level page model is described in Framework / Page system.

Next

History

1 changesCollapseExpand
1 + ---
2 + title: Plugins
3 + sidebar:
4 + label: Plugins
5 + order: 30
6 + collapsed: true
7 + ---
8 + # Plugins
9 +
10 + Plugins add features to a Riebeckite site. Use them when you want more than plain Markdown: Obsidian syntax, search, diagrams, media, SEO, discovery widgets, localization, and diagnostics.
11 +
12 + ## What do you want to do?
13 +
14 + | Goal | Plugin |
15 + | --- | --- |
16 + | Use Obsidian WikiLinks and embeds | [Obsidian Markdown](./obsidian-markdown.en.md) |
17 + | Show Mermaid diagrams | [Mermaid](./mermaid.en.md) |
18 + | Add site search | [Search](./search.en.md) |
19 + | Use tags and classification pages | [Taxonomy](./taxonomy.en.md) |
20 + | Show backlinks | [Backlinks](./backlinks.en.md) |
21 + | Enlarge images in an overlay | [Lightbox](./lightbox.en.md) |
22 + | Show Excalidraw drawings | [Excalidraw](./excalidraw.en.md) |
23 + | Show how notes relate to each other | [ExcaliBrain](./excalibrain.en.md) |
24 + | Show Obsidian Canvas files | [Canvas](./canvas.en.md) |
25 + | Use BibTeX citations | [Citations](./citations.en.md) |
26 + | Build a multilingual site | [Localization](./l10n.en.md) |
27 + | Add docs sidebar and previous/next links | [Docs](./docs.en.md) |
28 +
29 + This table is an entry point, not the full API reference. For all packages, see the list below.
30 +
31 + ## Add a Plugin
32 +
33 + Install the package:
34 +
35 + ```bash
36 + npm install @riebeckite/plugin-search
37 + ```
38 +
39 + Register it in the `plugins` array of `riebeckite.config.ts`:
40 +
41 + ```ts
42 + import { searchPlugin } from "@riebeckite/plugin-search";
43 +
44 + export default defineConfig({
45 + plugins: [searchPlugin()],
46 + });
47 + ```
48 +
49 + Each Plugin page shows the package name, import name, and common settings. The package README remains the source of truth for detailed options.
50 +
51 + ## Official Plugins
52 +
53 + Each page links to the Plugin reference. Install any Plugin with
54 + `npm install @riebeckite/plugin-<slug>` and register it in `riebeckite.config.ts`.
55 +
56 + ### Markdown and notes
57 +
58 + | Plugin | What it does |
59 + | --- | --- |
60 + | [Obsidian Markdown](./obsidian-markdown.en.md) | WikiLinks, embeds, callouts, and Obsidian-flavored syntax |
61 + | [Shortcodes](./shortcodes.en.md) | Inline, block, and container directives for reusable snippets |
62 + | [Highlight](./highlight.en.md) | Obsidian-style inline highlighting |
63 + | [Alias](./alias.en.md) | Obsidian alias redirects for notes |
64 + | [Properties](./properties.en.md) | Frontmatter property panels |
65 + | [Bases](./bases.en.md) | Build-time Obsidian Bases tables |
66 + | [Citations](./citations.en.md) | BibTeX and BibLaTeX citations |
67 + | [Sidenotes](./sidenotes.en.md) | Tufte-style side notes with mobile popovers |
68 + | [Text Fragment](./text-fragment.en.md) | Text Fragment links and quotes |
69 + | [Diff](./diff.en.md) | Git-backed note diffs and revision history |
70 + | [Daily Notes](./daily-notes.en.md) | Daily Note snippet widgets |
71 + | [Flashcards](./flashcards.en.md) | Interactive flashcard decks from code blocks |
72 + | [Kanban](./kanban.en.md) | Build-time Obsidian Kanban boards |
73 + | [Hover Preview](./hover-preview.en.md) | Popover previews for internal links |
74 +
75 + ### Diagrams and presentation
76 +
77 + | Plugin | What it does |
78 + | --- | --- |
79 + | [Mermaid](./mermaid.en.md) | Mermaid diagrams from code blocks |
80 + | [D2](./d2.en.md) | D2 diagrams from code blocks |
81 + | [Graphviz](./graphviz.en.md) | Graphviz DOT graphs |
82 + | [PlantUML](./plantuml.en.md) | PlantUML diagrams from code blocks |
83 + | [Chart.js](./chartjs.en.md) | Chart.js charts from code blocks |
84 + | [Vega-Lite](./vega-lite.en.md) | Vega-Lite visualizations from code blocks |
85 + | [WaveDrom](./wavedrom.en.md) | WaveDrom timing diagrams |
86 + | [Markmap](./markmap.en.md) | Markdown mind maps with Markmap |
87 + | [Marp](./marp.en.md) | Build-time Marp slide decks |
88 + | [Excalidraw](./excalidraw.en.md) | Excalidraw attachment rendering |
89 + | [ExcaliBrain](./excalibrain.en.md) | Relationship maps for notes |
90 +
91 + ### Visuals and media
92 +
93 + | Plugin | What it does |
94 + | --- | --- |
95 + | [Attachment](./attachment.en.md) | Attachment link and embed rendering |
96 + | [Media](./media.en.md) | Audio and video embeds with timestamp fragments |
97 + | [Responsive Image](./responsive-image.en.md) | Responsive image markup and lazy loading |
98 + | [Gallery](./gallery.en.md) | Markdown-driven card galleries |
99 + | [Lightbox](./lightbox.en.md) | Click-to-zoom image lightboxes |
100 + | [PDF](./pdf.en.md) | Inline PDF attachment viewing |
101 + | [QR Code](./qr-code.en.md) | Inline SVG QR codes from code blocks |
102 + | [Map](./map.en.md) | Interactive and static OpenStreetMap embeds |
103 + | [Rich Embed](./rich-embed.en.md) | Build-time rich media embeds |
104 + | [AutoCardLink](./autocardlink.en.md) | Link preview cards from `cardlink` blocks |
105 +
106 + ### Code and reading experience
107 +
108 + | Plugin | What it does |
109 + | --- | --- |
110 + | [Code Enhance](./code-enhance.en.md) | Enhanced syntax-highlighted code blocks |
111 + | [Code Tabs](./code-tabs.en.md) | Accessible tabbed code blocks |
112 + | [Code Annotations](./code-annotations.en.md) | Code annotations, highlights, and diff markers |
113 + | [Table of Contents](./toc.en.md) | Scroll-aware in-page table of contents |
114 + | [UX](./ux.en.md) | Reading experience enhancements |
115 + | [color-mode](./color-mode.en.md) | Light, dark, and system color-mode switching |
116 +
117 + ### Search and navigation
118 +
119 + | Plugin | What it does |
120 + | --- | --- |
121 + | [Search](./search.en.md) | Client-side full-text search |
122 + | [Navigation](./navigation.en.md) | Site navigation derived from the vault or authored in config |
123 + | [Backlinks](./backlinks.en.md) | Backlink lists for published notes |
124 + | [Breadcrumbs](./breadcrumbs.en.md) | Slug-hierarchy breadcrumb navigation |
125 + | [Local Graph](./local-graph.en.md) | Local note graph visualizations |
126 + | [Garden Explorer](./garden-explorer.en.md) | Interactive graph and search explorer |
127 + | [Recent Posts](./recent-posts.en.md) | Recent posts lists |
128 + | [Related Posts](./related-posts.en.md) | Build-time related-post navigation |
129 + | [Series](./series.en.md) | Ordered multi-part post navigation |
130 + | [Taxonomy](./taxonomy.en.md) | Tag and folder taxonomy, per-term feeds, and SEO |
131 + | [Query](./query.en.md) | Build-time content queries from code blocks |
132 + | [Dataview](./dataview.en.md) | Build-time Dataview queries |
133 + | [Folder Pages](./folder-pages.en.md) | Folder entry pages and generated listings |
134 + | [Archive](./archive.en.md) | Monthly archive listing pages |
135 +
136 + ### Publishing and SEO
137 +
138 + | Plugin | What it does |
139 + | --- | --- |
140 + | [SEO](./seo.en.md) | Metadata, sitemaps, feeds, and robots.txt |
141 + | [Deploy](./deploy.en.md) | Static hosting deployment output |
142 + | [Permalink](./permalink.en.md) | Stable, configurable content permalinks |
143 + | [Rename](./rename.en.md) | Rename and move redirects for published notes |
144 + | [Analytics](./analytics.en.md) | Storage-independent analytics foundation |
145 + | [Changelog](./changelog.en.md) | Git-backed change history and changelogs |
146 + | [Webmention](./webmention.en.md) | Verified Webmention receiving and rendering |
147 + | [Share](./share.en.md) | Per-article share links and copy-to-clipboard |
148 +
149 + ### Content and developer experience
150 +
151 + | Plugin | What it does |
152 + | --- | --- |
153 + | [Localization](./l10n.en.md) | Content localization, localized URLs, and translation metadata |
154 + | [Quality](./quality.en.md) | Static quality and accessibility inspection |
155 + | [Diagnostics](./diagnostics.en.md) | Content diagnostics for Riebeckite and Obsidian vaults |
156 + | [Docs](./docs.en.md) | Docs sidebar and previous/next navigation |
157 + | [Canvas](./canvas.en.md) | Obsidian Canvas diagram rendering |
158 + | [Discord Embed](./discord-embed.en.md) | Discord link preview metadata |
159 +
160 + ## If you want to build a Plugin
161 +
162 + Start with [Writing a Plugin](./writing-a-plugin.en.md). Exact contracts live in [Plugin API](../reference/plugin-api.en.md), and the framework-level page model is described in [Framework / Page system](../framework/page-system.en.md).
163 +
164 + ## Next
165 +
166 + - [Plugin Showcase](./showcase.en.md)
167 + - [Writing a Plugin](./writing-a-plugin.en.md)
168 +

Local Graph

Nearby Notes

Open in Explorer →
Pluginsshowcase.en
CurrentOutgoingBacklink