Plugin Showcase
The Plugin catalog lives in Plugins. This page shows what each Plugin actually produces. Each entry pairs the Markdown source with the result rendered by Riebeckite.
The generated
showcasepreset lets you try examples like these locally.
Obsidian Markdown
Callouts — obsidian-markdown
Source
> [!tip] Try it
> A callout is a block quote with a `[!type]` marker.
> `[!info]`, `[!warning]`, and `[!question]` render the same way.
Rendered
A callout is a block quote with a [!type] marker.
[!info], [!warning], and [!question] render the same way.
WikiLinks and embeds — obsidian-markdown
Source
A WikiLink to [[README]] and to [[plugins/README|Plugin catalog]].
Rendered
A WikiLink to README and to Plugin catalog.
Code
Code with a toolbar — code-enhance
Line numbers, a filename bar, line highlighting, and a copy button.
Source
```ts title="hello.ts"
export function hello(name: string): string {
return `Hello, ${name}`;
}
```
Rendered
export function hello(name: string): string {
return `Hello, ${name}`;
}
Code tabs — code-tabs
Adjacent code fences with tab="..." become a single tab group.
Source
```ts tab="React"
const greeting = "Hello from React";
```
```js tab="Vanilla"
console.log("Hello from JavaScript");
```
Rendered
const greeting = "Hello from React";
console.log("Hello from JavaScript");
Code annotations
Fence metadata and inline comments express line highlighting, additions, removals, and focus.
Source
```js {2}
const first = 1;
const second = 2;
const third = 3;
```
```js
const kept = true;
const added = "new line"; // [!code ++]
const removed = false; // [!code --]
```
```js
const focused = 1; // [!code focus]
const plain = 2;
```
Rendered
const first = 1;
const second = 2;
const third = 3;
const kept = true;
const added = "new line";
const removed = false;
const focused = 1;
const plain = 2;
Inline
Highlight
Text wrapped in ==...== is emphasized inline.
Source
This sentence contains an ==emphasized== span; the rest stays unchanged.
Rendered
This sentence contains an emphasized span; the rest stays unchanged.
Sidenotes
Footnote syntax becomes a side note next to the body.
Source
We reference a side note here.[^1]
[^1]: This is the side note body.
Rendered
We reference a side note here.1
Shortcodes
::name and :::name directives insert badges, keyboard keys, notes, and more.
Source
::badge[Stable]{variant=success}
::kbd[Ctrl+Shift+P]
:::note[Note]
You can write body text as-is.
:::
Rendered
Note
You can write body text as-is.
Diagrams
Mermaid — mermaid
Source
```mermaid
flowchart LR
A[Note] --> B{Published?}
B -->|yes| C[Site]
B -->|no| D[Draft]
```
Rendered
Diagram source
flowchart LR
A[Note] --> B{Published?}
B -->|yes| C[Site]
B -->|no| D[Draft]
D2 — d2
Source
```d2
site: Riebeckite
content -> build -> deploy
```
Rendered
Diagram source
site: Riebeckite
content -> build -> deploy
Graphviz / DOT — graphviz
Source
```dot
digraph G {
notes -> pages;
pages -> html;
}
```
Rendered
Diagram source
digraph G {
notes -> pages;
pages -> html;
}
Chart.js — chartjs
Source
```chart
{
"type": "bar",
"data": {
"labels": ["Mon", "Tue", "Wed"],
"datasets": [{ "label": "Visits", "data": [12, 19, 8] }]
}
}
```
Rendered
Vega-Lite — vega-lite
Source
```vega-lite
{
"title": "Revenue",
"data": { "values": [{ "category": "A", "value": 28 }, { "category": "B", "value": 55 }] },
"mark": "bar",
"encoding": {
"x": { "field": "category", "type": "nominal" },
"y": { "field": "value", "type": "quantitative" }
}
}
```
Rendered
Vega-Lite spec
{
"title": "Revenue",
"data": { "values": [{ "category": "A", "value": 28 }, { "category": "B", "value": 55 }] },
"mark": "bar",
"encoding": {
"x": { "field": "category", "type": "nominal" },
"y": { "field": "value", "type": "quantitative" }
}
}
WaveDrom — wavedrom
Source
```wavedrom
{ "signal": [
{ "name": "clk", "wave": "p......" },
{ "name": "bus", "wave": "x.34.5x", "data": "head body tail" }
] }
```
Rendered
WaveJSON source
{ "signal": [
{ "name": "clk", "wave": "p......" },
{ "name": "bus", "wave": "x.34.5x", "data": "head body tail" }
] }
Markmap — markmap
Source
```markmap
# Project
## Design
### Notation
### Rendering
## Delivery
```
Rendered
Markdown source
# Project
## Design
### Notation
### Rendering
## Delivery
Marp slides — marp
Source
```marp title="Intro deck"
# First slide
- a bullet
---
# Second slide
```
Rendered
First slide
- a bullet
Second slide
Marp source
# First slide
- a bullet
---
# Second slide
Maps — map
A static fallback renders first, then expands to an interactive map where JavaScript is available.
Source
```map
center: 35.6812, 139.7671
zoom: 13
label: Tokyo Station
markers:
- 35.6812, 139.7671 | Tokyo Station
- 35.6586, 139.7454 | Tokyo Tower
```
Rendered
Tokyo Station
© OpenStreetMap contributors
Map source
center: 35.6812, 139.7671
zoom: 13
label: Tokyo Station
markers:
- 35.6812, 139.7671 | Tokyo Station
- 35.6586, 139.7454 | Tokyo Tower
QR codes — qr-code
Generated as inline SVG at build time.
Source
```qr
# caption: Project page
https://example.com/
```
Rendered
PlantUML — plantuml
The diagram becomes an image URL pointing at a PlantUML server at build time. Viewing it requires reaching that server.
Source
```plantuml
@startuml
Alice -> Bob: Hello
Bob --> Alice: Hi
@enduml
```
Rendered
Diagram source
@startuml
Alice -> Bob: Hello
Bob --> Alice: Hi
@enduml
Canvas — canvas
Write JSON Canvas directly in a code fence, or embed a Canvas file with ![[diagram.canvas]].
Source
```canvas
{
"nodes": [
{ "id": "note", "type": "text", "x": 0, "y": 0, "width": 240, "height": 100, "text": "Note" }
],
"edges": []
}
```
Rendered
Canvas nodes and edges
- text
note— Note
Media
Rich embeds — rich-embed
Turn a URL into an embed for YouTube, Vimeo, Spotify, CodePen, Gist, and more.
Source
```embed
https://www.youtube.com/watch?v=dQw4w9WgXcQ
title: Demo video
caption: A short caption
aspect: 16/9
```
Rendered
Gallery cards — gallery
Source
```gallery
columns: 3
items:
- title: Default
description: A clean, typographic theme.
href: https://riebeckite.dev/docs/themes/default
- title: Minimal
description: Stripped back to the essentials.
href: https://riebeckite.dev/docs/themes/minimal
- title: Gruvbox
description: A warm, high-contrast palette.
href: https://riebeckite.dev/docs/themes/gruvbox
```
Rendered
Excalidraw — excalidraw
Embedding an Excalidraw note replaces it with an SVG in the browser. This site embeds the drawing in assets/HW.md.
Source
![[HW]]
Rendered
Responsive image — responsive-image
Embedding an image with ![[...]] expands to a <picture> element with multiple size candidates when the variants exist.
Source
![[riebeckite-logo-horizontal.png]]
Rendered
AutoCardLink
A cardlink fence with a URL and metadata becomes a link card.
Source
```cardlink
url: https://example.com/riebeckite
title: Riebeckite
description: A tool that builds a static site from Markdown
host: example.com
```
Rendered
Knowledge and data
Dataview — dataview
Source
```dataview
TABLE file.name AS "Name", status
FROM #project
WHERE status = "active"
SORT file.name asc
LIMIT 10
```
Rendered
No matching content.
Dataview query
TABLE file.name AS "Name", status
FROM #project
WHERE status = "active"
SORT file.name asc
LIMIT 10Query — query
Source
```query
sort:
field: title
order: asc
limit: 5
```
Rendered
Bases — bases
Source
```base
filters:
and:
- file.hasTag("featured")
properties:
file.name:
displayName: Title
views:
- type: table
name: Featured
limit: 10
```
Rendered
Featured
| Title |
|---|
| Riebeckite |
| README |
| HW |
| Documentation |
| ドキュメント |
| Accessibility |
| アクセシビリティ |
| Framework |
| Framework |
| architecture.en |
Base definition
filters:
and:
- file.hasTag("featured")
properties:
file.name:
displayName: Title
views:
- type: table
name: Featured
limit: 10Kanban boards — kanban
Put ## column headings and task lists in the body to get a board.
Source
## Backlog
- [ ] Draft the release notes
- [ ] Link to [[README]]
## Done
- [x] Publish the fixture
Rendered
- Draft the release notes
- Link to README
- Publish the fixture
Flashcards
A flashcards fence of front :: back pairs becomes a study deck. It still reads as a static list without JavaScript.
Source
```flashcards
What is Riebeckite? :: A tool that builds a static site from Markdown
What is the unit of publishing? :: A note
```
Rendered
- What is Riebeckite?A tool that builds a static site from Markdown
- What is the unit of publishing?A note
ExcaliBrain — excalibrain
Shows each note's relationships across seven regions. The body of the excalibrain fence is ignored; the fence only marks where to draw, and the map is assembled from the page's own links.
Source
```excalibrain
```
Rendered
The map above is built from this page's WikiLinks. Because each Plugin page is linked with a Markdown relative link, only pages named by WikiLink appear under child. parent lists pages that WikiLink to this page, and sibling lists pages that those parent pages WikiLink to.
Plugins that act on the page or site
These Plugins cannot be expressed by a single Markdown fragment. They are visible on this page as the search box, table of contents, color mode toggle, and so on.
| Plugin | What to look for |
|---|---|
search |
A search box that filters the site |
toc |
A table of contents that follows scroll position |
backlinks |
A list of notes that reference this note |
related-posts |
Related notes at the bottom of a note |
properties |
A list of frontmatter properties |
| breadcrumbs | Page hierarchy breadcrumbs |
| share | Share controls for a note |
| hover-preview | A hover preview of link targets |
local-graph |
A mini graph of nearby notes |
garden-explorer |
The explorer Page Type with a graph and search |
taxonomy |
The tag and folder listing Page Types |
docs |
The Docs sidebar and previous/next links |
| folder-pages | An index Page Type for each folder |
lightbox |
Click to enlarge an image |
diff / changelog |
Per-note git history |
l10n |
The language switcher on translated pages |
color-mode |
Light / dark / system switching |
Plugins that act at build time or on metadata
These Plugins do not appear in the body. Their results show up as generated files, head tags, or redirects.
| Plugin | What it generates |
|---|---|
seo |
sitemap.xml / robots.txt / feeds, plus canonical and OGP head tags |
| webmention | webmentions.json and the send/receive endpoints |
alias |
Redirects from alternative names |
| series | Previous/next navigation from series frontmatter |
recent-posts |
A list of recent notes, placed by the site |
daily-notes |
Short snippets from Daily Notes, placed by the site |
| rename | Redirects from old paths |
deploy |
Deployment config files for each host |
diagnostics |
Diagnostics for orphan notes and unused assets |
quality |
Quality checks such as heading order and duplicate ids |
Related
Footnotes
-
This is the side note body. ↩
