Plugin Showcase
Plugin catalog は Plugins にあります。このページでは、Plugin が実際に何を生成するかを確認できます。各項目では Markdown のソースと、Riebeckite 上での実行例を並べています。
生成される
showcasepreset では、ここにあるような例をローカルで確認できます。
Obsidian Markdown
Callouts — obsidian-markdown
ソース
> [!tip] 試してみる
> Callout は `[!type]` マーカー付きの block quote です。
> `[!info]`、`[!warning]`、`[!question]` も同じように表示されます。
実行例
Callout は [!type] マーカー付きの block quote です。
[!info]、[!warning]、[!question] も同じように表示されます。
WikiLinks と埋め込み — obsidian-markdown
ソース
[[README]] と [[plugins/README|Plugin catalog]] への WikiLink。
実行例
README と Plugin catalog への WikiLink。
Code
Toolbar 付きコード — code-enhance
行番号、ファイル名バー、行ハイライト、copy button を確認できます。
ソース
```ts title="hello.ts"
export function hello(name: string): string {
return `こんにちは、${name}`;
}
```
実行例
export function hello(name: string): string {
return `こんにちは、${name}`;
}
Code tabs — code-tabs
隣り合った tab="..." 付き code fence が、1 つの tab group になります。
ソース
```ts tab="React"
const greeting = "Hello from React";
```
```js tab="Vanilla"
console.log("Hello from JavaScript");
```
実行例
const greeting = "Hello from React";
console.log("Hello from JavaScript");
Code annotations
フェンスのメタ情報とインラインコメントで、行のハイライト、追加・削除、フォーカスを表現します。
ソース
```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;
```
実行例
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;
インライン表現
Highlight
==text== で囲んだ範囲をインラインで強調します。
ソース
この文は ==強調== され、ほかはそのまま表示されます。
実行例
この文は 強調 され、ほかはそのまま表示されます。
Sidenotes
脚注記法が、本文の横に並ぶ補足へ変換されます。
ソース
本文中で補足を参照します。[^1]
[^1]: ここが sidenote の本文です。
実行例
本文中で補足を参照します。1
Shortcodes
::name と :::name のディレクティブで、badge、kbd、note などを差し込みます。
ソース
::badge[Stable]{variant=success}
::kbd[Ctrl+Shift+P]
:::note[補足]
本文をそのまま書けます。
:::
実行例
補足
本文をそのまま書けます。
図表
Mermaid — mermaid
ソース
```mermaid
flowchart LR
A[Note] --> B{Published?}
B -->|yes| C[Site]
B -->|no| D[Draft]
```
実行例
Diagram source
flowchart LR
A[Note] --> B{Published?}
B -->|yes| C[Site]
B -->|no| D[Draft]
D2 — d2
ソース
```d2
site: Riebeckite
content -> build -> deploy
```
実行例
Diagram source
site: Riebeckite
content -> build -> deploy
Graphviz / DOT — graphviz
ソース
```dot
digraph G {
notes -> pages;
pages -> html;
}
```
実行例
Diagram source
digraph G {
notes -> pages;
pages -> html;
}
Chart.js — chartjs
ソース
```chart
{
"type": "bar",
"data": {
"labels": ["Mon", "Tue", "Wed"],
"datasets": [{ "label": "Visits", "data": [12, 19, 8] }]
}
}
```
実行例
Vega-Lite — vega-lite
ソース
```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" }
}
}
```
実行例
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
ソース
```wavedrom
{ "signal": [
{ "name": "clk", "wave": "p......" },
{ "name": "bus", "wave": "x.34.5x", "data": "head body tail" }
] }
```
実行例
WaveJSON source
{ "signal": [
{ "name": "clk", "wave": "p......" },
{ "name": "bus", "wave": "x.34.5x", "data": "head body tail" }
] }
Markmap — markmap
ソース
```markmap
# Project
## Design
### Notation
### Rendering
## Delivery
```
実行例
Markdown source
# Project
## Design
### Notation
### Rendering
## Delivery
Marp slides — marp
ソース
```marp title="Intro deck"
# First slide
- a bullet
---
# Second slide
```
実行例
First slide
- a bullet
Second slide
Marp source
# First slide
- a bullet
---
# Second slide
Maps — map
静的な fallback を先に表示し、JavaScript が有効な環境では interactive map に拡張します。
ソース
```map
center: 35.6812, 139.7671
zoom: 13
label: Tokyo Station
markers:
- 35.6812, 139.7671 | Tokyo Station
- 35.6586, 139.7454 | Tokyo Tower
```
実行例
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
Build 時に inline SVG として生成します。
ソース
```qr
# caption: Project page
https://example.com/
```
実行例
PlantUML — plantuml
図はビルド時に PlantUML サーバーの画像 URL へ変換されます。表示にはそのサーバーへ到達できる必要があります。
ソース
```plantuml
@startuml
Alice -> Bob: Hello
Bob --> Alice: Hi
@enduml
```
実行例
Diagram source
@startuml
Alice -> Bob: Hello
Bob --> Alice: Hi
@enduml
Canvas — canvas
JSON Canvas をコードフェンスへ直接書くか、![[diagram.canvas]] で Canvas ファイルを埋め込みます。
ソース
```canvas
{
"nodes": [
{ "id": "note", "type": "text", "x": 0, "y": 0, "width": 240, "height": 100, "text": "Note" }
],
"edges": []
}
```
実行例
Canvas nodes and edges
- text
note— Note
Media
Rich embeds — rich-embed
URL を YouTube、Vimeo、Spotify、CodePen、Gist などの埋め込みに変換します。
ソース
```embed
https://www.youtube.com/watch?v=dQw4w9WgXcQ
title: Demo video
caption: A short caption
aspect: 16/9
```
実行例
Gallery cards — gallery
ソース
```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
```
実行例
Excalidraw — excalidraw
Excalidraw 形式のノートを埋め込むと、ブラウザ側で SVG に置き換わります。このサイトでは assets/HW.md の図を埋め込んでいます。
ソース
![[HW]]
実行例
Responsive image — responsive-image
画像を ![[...]] で埋め込むと、対応する候補画像がある場合は <picture> と複数サイズの候補に展開されます。
ソース
![[riebeckite-logo-horizontal.png]]
実行例
AutoCardLink
cardlink フェンスに URL とメタ情報を書くと、リンクカードになります。
ソース
```cardlink
url: https://example.com/riebeckite
title: Riebeckite
description: Markdown から静的サイトを作るツール
host: example.com
```
実行例
ナレッジとデータ
Dataview — dataview
ソース
```dataview
TABLE file.name AS "Name", status
FROM #project
WHERE status = "active"
SORT file.name asc
LIMIT 10
```
実行例
No matching content.
Dataview query
TABLE file.name AS "Name", status
FROM #project
WHERE status = "active"
SORT file.name asc
LIMIT 10Query — query
ソース
```query
sort:
field: title
order: asc
limit: 5
```
実行例
Bases — bases
ソース
```base
filters:
and:
- file.hasTag("featured")
properties:
file.name:
displayName: Title
views:
- type: table
name: Featured
limit: 10
```
実行例
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
本文に ## 見出しの列と task list を置くと board になります。
ソース
## Backlog
- [ ] Draft the release notes
- [ ] Link to [[README]]
## Done
- [x] Publish the fixture
実行例
- Draft the release notes
- Link to README
- Publish the fixture
Flashcards
front :: back を並べた flashcards フェンスが、学習用のデッキになります。JavaScript が無効な環境でも静的なリストとして読めます。
ソース
```flashcards
Riebeckite とは? :: Markdown から静的サイトを作るツール
公開の単位は? :: Note
```
実行例
- Riebeckite とは?Markdown から静的サイトを作るツール
- 公開の単位は?Note
ExcaliBrain — excalibrain
ノートごとの関係を 7 つの領域に分けて表示します。excalibrain フェンスの中身は読みません。フェンスは「ここに描画する」という位置だけを決め、マップの中身はそのページ自身のリンクから組み立てます。
ソース
```excalibrain
```
実行例
上のマップには、このページの WikiLink から推論した関係が入ります。各 Plugin ページへは Markdown の相対リンクでリンクしているため、child に入るのは WikiLink で指定したページだけです。parent にはこのページへ WikiLink でリンクしているページが、sibling には parent が WikiLink でリンクしているページが並びます。
ページやサイト全体に作用する Plugin
次の Plugin は 1 つの Markdown 断片では表現できません。このページ上でも検索 box、目次、color mode toggle などとして確認できます。
| Plugin | 確認するもの |
|---|---|
search |
サイトを絞り込む検索ボックス |
toc |
スクロール位置に追従する目次 |
backlinks |
このノートを参照するノートの一覧 |
related-posts |
note 末尾の関連記事一覧 |
properties |
フロントマターのプロパティ一覧 |
| breadcrumbs | ページ階層のパンくず |
| share | note の共有ボタン |
| hover-preview | リンク先を表示するホバープレビュー |
local-graph |
周辺ノートのミニグラフ |
garden-explorer |
graph と検索の explorer Page Type |
taxonomy |
tag と folder の一覧 Page Type |
docs |
Docs の sidebar と previous/next |
| folder-pages | folder ごとの index Page Type |
lightbox |
画像を拡大する操作 |
diff / changelog |
note ごとの git history |
l10n |
翻訳ページ上の language switcher |
color-mode |
light / dark / system の切り替え |
ビルド時・メタデータに作用する Plugin
本文には現れず、生成物や head、リダイレクトとして結果が出る Plugin です。
| Plugin | 生成されるもの |
|---|---|
seo |
sitemap.xml / robots.txt / feed / head の canonical と OGP |
| webmention | webmentions.json と送受信のエンドポイント |
alias |
別名からのリダイレクト |
| series | series frontmatter による前後ナビ |
recent-posts |
最新記事の一覧(Site が配置) |
daily-notes |
デイリーノートの短いスニペット(Site が配置) |
| rename | 旧パスからのリダイレクト |
deploy |
各ホスト向けのデプロイ設定ファイル |
diagnostics |
孤立ノートや未使用アセットの診断 |
quality |
見出し順や重複 id などの品質チェック |
関連
Footnotes
-
ここが sidenote の本文です。 ↩
