|
1 |
+ --- |
|
2 |
+ title: Plugins |
|
3 |
+ sidebar: |
|
4 |
+ label: Plugins |
|
5 |
+ order: 30 |
|
6 |
+ collapsed: true |
|
7 |
+ --- |
|
8 |
+ # Plugins |
|
9 |
+ |
|
10 |
+ Plugin は、Riebeckite のサイトに機能を追加する仕組みです。通常の Markdown だけでは足りないとき、Obsidian 記法、検索、図表、メディア、SEO、記事の発見、多言語対応、診断などを追加できます。 |
|
11 |
+ |
|
12 |
+ ## 何をしたいですか？ |
|
13 |
+ |
|
14 |
+ | やりたいこと | Plugin | |
|
15 |
+ | --- | --- | |
|
16 |
+ | Obsidian の WikiLink や埋め込みを使いたい | [Obsidian Markdown](./obsidian-markdown.md) | |
|
17 |
+ | Mermaid を表示したい | [Mermaid](./mermaid.md) | |
|
18 |
+ | サイト内検索を追加したい | [Search](./search.md) | |
|
19 |
+ | タグや分類を使いたい | [Taxonomy](./taxonomy.md) | |
|
20 |
+ | Backlink を表示したい | [Backlinks](./backlinks.md) | |
|
21 |
+ | 画像を拡大表示したい | [Lightbox](./lightbox.md) | |
|
22 |
+ | Excalidraw を表示したい | [Excalidraw](./excalidraw.md) | |
|
23 |
+ | ノート間の関係図を表示したい | [ExcaliBrain](./excalibrain.md) | |
|
24 |
+ | Obsidian Canvas を表示したい | [Canvas](./canvas.md) | |
|
25 |
+ | BibTeX の引用を使いたい | [Citations](./citations.md) | |
|
26 |
+ | 多言語サイトにしたい | [Localization](./l10n.md) | |
|
27 |
+ | Docs 用の sidebar と previous/next を追加したい | [Docs](./docs.md) | |
|
28 |
+ |
|
29 |
+ この表は、目的から探すための入口です。すべての Plugin は下の一覧から確認できます。 |
|
30 |
+ |
|
31 |
+ ## Plugin を追加する |
|
32 |
+ |
|
33 |
+ package をインストールします。 |
|
34 |
+ |
|
35 |
+ ```bash |
|
36 |
+ npm install @riebeckite/plugin-search |
|
37 |
+ ``` |
|
38 |
+ |
|
39 |
+ `riebeckite.config.ts` の `plugins` に登録します。 |
|
40 |
+ |
|
41 |
+ ```ts |
|
42 |
+ import { searchPlugin } from "@riebeckite/plugin-search"; |
|
43 |
+ |
|
44 |
+ export default defineConfig({ |
|
45 |
+ plugins: [searchPlugin()], |
|
46 |
+ }); |
|
47 |
+ ``` |
|
48 |
+ |
|
49 |
+ 各 Plugin ページでは、package 名、import 名、よく使う設定を説明します。詳しい option は各 package README を参照してください。 |
|
50 |
+ |
|
51 |
+ ## 公式 Plugin |
|
52 |
+ |
|
53 |
+ 各ページから Plugin のリファレンスへ移動できます。導入は `npm install @riebeckite/plugin-<slug>` で行い、`riebeckite.config.ts` に登録します。 |
|
54 |
+ |
|
55 |
+ ### Markdown とノート |
|
56 |
+ |
|
57 |
+ | Plugin | できること | |
|
58 |
+ | --- | --- | |
|
59 |
+ | [Obsidian Markdown](./obsidian-markdown.md) | WikiLink、埋め込み、callout など Obsidian 記法 | |
|
60 |
+ | [Shortcodes](./shortcodes.md) | 再利用できるインライン・ブロック・コンテナのディレクティブ | |
|
61 |
+ | [Highlight](./highlight.md) | Obsidian 風のインライン強調 | |
|
62 |
+ | [Alias](./alias.md) | Obsidian の alias によるリダイレクト | |
|
63 |
+ | [Properties](./properties.md) | frontmatter プロパティのパネル表示 | |
|
64 |
+ | [Bases](./bases.md) | Obsidian Bases のビルド時テーブル | |
|
65 |
+ | [Citations](./citations.md) | BibTeX・BibLaTeX の引用 | |
|
66 |
+ | [Sidenotes](./sidenotes.md) | モバイルのポップオーバー付きの傍注 | |
|
67 |
+ | [Text Fragment](./text-fragment.md) | Text Fragment リンクと引用 | |
|
68 |
+ | [Diff](./diff.md) | Git によるノートの差分と変更履歴 | |
|
69 |
+ | [Daily Notes](./daily-notes.md) | Daily Note のスニペット表示 | |
|
70 |
+ | [Flashcards](./flashcards.md) | コードブロックから作るフラッシュカード | |
|
71 |
+ | [Kanban](./kanban.md) | Obsidian Kanban のビルド時描画 | |
|
72 |
+ | [Hover Preview](./hover-preview.md) | 内部リンクのホバープレビュー | |
|
73 |
+ |
|
74 |
+ ### 図とプレゼンテーション |
|
75 |
+ |
|
76 |
+ | Plugin | できること | |
|
77 |
+ | --- | --- | |
|
78 |
+ | [Mermaid](./mermaid.md) | コードブロックからの Mermaid 図 | |
|
79 |
+ | [D2](./d2.md) | コードブロックからの D2 図 | |
|
80 |
+ | [Graphviz](./graphviz.md) | Graphviz の DOT グラフ | |
|
81 |
+ | [PlantUML](./plantuml.md) | コードブロックからの PlantUML 図 | |
|
82 |
+ | [Chart.js](./chartjs.md) | コードブロックからの Chart.js グラフ | |
|
83 |
+ | [Vega-Lite](./vega-lite.md) | コードブロックからの Vega-Lite 可視化 | |
|
84 |
+ | [WaveDrom](./wavedrom.md) | WaveDrom のタイミング図 | |
|
85 |
+ | [Markmap](./markmap.md) | Markmap による Markdown マインドマップ | |
|
86 |
+ | [Marp](./marp.md) | ビルド時の Marp スライド | |
|
87 |
+ | [Excalidraw](./excalidraw.md) | Excalidraw 添付の描画 | |
|
88 |
+ | [ExcaliBrain](./excalibrain.md) | ノートの関係マップ | |
|
89 |
+ |
|
90 |
+ ### ビジュアルとメディア |
|
91 |
+ |
|
92 |
+ | Plugin | できること | |
|
93 |
+ | --- | --- | |
|
94 |
+ | [Attachment](./attachment.md) | 添付ファイルのリンクと埋め込み | |
|
95 |
+ | [Media](./media.md) | タイムスタンプ指定付きの音声・動画埋め込み | |
|
96 |
+ | [Responsive Image](./responsive-image.md) | レスポンシブ画像と遅延読み込み | |
|
97 |
+ | [Gallery](./gallery.md) | Markdown で書くカードギャラリー | |
|
98 |
+ | [Lightbox](./lightbox.md) | クリックで拡大する画像表示 | |
|
99 |
+ | [PDF](./pdf.md) | PDF 添付のインライン表示 | |
|
100 |
+ | [QR Code](./qr-code.md) | コードブロックからのインライン SVG QR コード | |
|
101 |
+ | [Map](./map.md) | OpenStreetMap の対話的・静的な埋め込み | |
|
102 |
+ | [Rich Embed](./rich-embed.md) | ビルド時のリッチメディア埋め込み | |
|
103 |
+ | [AutoCardLink](./autocardlink.md) | `cardlink` ブロックからのリンクプレビューカード | |
|
104 |
+ |
|
105 |
+ ### コードと読書体験 |
|
106 |
+ |
|
107 |
+ | Plugin | できること | |
|
108 |
+ | --- | --- | |
|
109 |
+ | [Code Enhance](./code-enhance.md) | 拡張したシンタックスハイライト | |
|
110 |
+ | [Code Tabs](./code-tabs.md) | アクセシブルなタブ付きコードブロック | |
|
111 |
+ | [Code Annotations](./code-annotations.md) | コードの注釈・強調・差分マーカー | |
|
112 |
+ | [Table of Contents](./toc.md) | スクロールに追従する目次 | |
|
113 |
+ | [UX](./ux.md) | 読書体験の強化 | |
|
114 |
+ | [color-mode](./color-mode.md) | ライト・ダーク・システムの切り替え | |
|
115 |
+ |
|
116 |
+ ### 検索とナビゲーション |
|
117 |
+ |
|
118 |
+ | Plugin | できること | |
|
119 |
+ | --- | --- | |
|
120 |
+ | [Search](./search.md) | クライアントサイドの全文検索 | |
|
121 |
+ | [Navigation](./navigation.md) | vault 由来または設定で書くサイトナビゲーション | |
|
122 |
+ | [Backlinks](./backlinks.md) | 公開ノートの被リンク一覧 | |
|
123 |
+ | [Breadcrumbs](./breadcrumbs.md) | slug 階層のパンくず | |
|
124 |
+ | [Local Graph](./local-graph.md) | ローカルノートグラフ | |
|
125 |
+ | [Garden Explorer](./garden-explorer.md) | グラフと検索の探索 UI | |
|
126 |
+ | [Recent Posts](./recent-posts.md) | 最近の記事一覧 | |
|
127 |
+ | [Related Posts](./related-posts.md) | ビルド時の関連記事ナビゲーション | |
|
128 |
+ | [Series](./series.md) | 連載記事の順序付きナビゲーション | |
|
129 |
+ | [Taxonomy](./taxonomy.md) | タグとフォルダの分類、用語別フィード、SEO | |
|
130 |
+ | [Query](./query.md) | コードブロックからのビルド時クエリ | |
|
131 |
+ | [Dataview](./dataview.md) | ビルド時の Dataview クエリ | |
|
132 |
+ | [Folder Pages](./folder-pages.md) | フォルダの入口ページと一覧生成 | |
|
133 |
+ | [Archive](./archive.md) | 月別アーカイブ一覧 | |
|
134 |
+ |
|
135 |
+ ### 公開と SEO |
|
136 |
+ |
|
137 |
+ | Plugin | できること | |
|
138 |
+ | --- | --- | |
|
139 |
+ | [SEO](./seo.md) | メタデータ、サイトマップ、フィード、robots.txt | |
|
140 |
+ | [Deploy](./deploy.md) | 静的ホスティング向けの出力 | |
|
141 |
+ | [Permalink](./permalink.md) | 安定した設定可能なパーマリンク | |
|
142 |
+ | [Rename](./rename.md) | 公開ノートのリネーム・移動リダイレクト | |
|
143 |
+ | [Analytics](./analytics.md) | 保存先に依存しない解析の基盤 | |
|
144 |
+ | [Changelog](./changelog.md) | Git による変更履歴とチェンジログ | |
|
145 |
+ | [Webmention](./webmention.md) | 検証済み Webmention の受信と表示 | |
|
146 |
+ | [Share](./share.md) | 記事ごとの共有リンクとクリップボードコピー | |
|
147 |
+ |
|
148 |
+ ### コンテンツと開発体験 |
|
149 |
+ |
|
150 |
+ | Plugin | できること | |
|
151 |
+ | --- | --- | |
|
152 |
+ | [Localization](./l10n.md) | コンテンツの多言語化、ローカライズ URL、翻訳メタデータ | |
|
153 |
+ | [Quality](./quality.md) | HTML の品質とアクセシビリティの静的検査 | |
|
154 |
+ | [Diagnostics](./diagnostics.md) | Riebeckite と Obsidian vault のコンテンツ診断 | |
|
155 |
+ | [Docs](./docs.md) | Docs のサイドバーと previous/next | |
|
156 |
+ | [Canvas](./canvas.md) | Obsidian Canvas の描画 | |
|
157 |
+ | [Discord Embed](./discord-embed.md) | Discord のリンクプレビューメタデータ | |
|
158 |
+ |
|
159 |
+ ## Plugin を作りたい場合 |
|
160 |
+ |
|
161 |
+ まず [Writing a Plugin](./writing-a-plugin.md) を読んでください。正確な contract は [Plugin API](../reference/plugin-api.md)、ページ生成の仕組みは [Framework / Page system](../framework/page-system.md) にあります。 |
|
162 |
+ |
|
163 |
+ ## 次に読むページ |
|
164 |
+ |
|
165 |
+ - [Plugin Showcase](./showcase.md) |
|
166 |
+ - [Writing a Plugin](./writing-a-plugin.md) |
|
167 |
+ |