Riebeckite
Menu
Color mode

Gallery

複数の画像やメディアをギャラリーとして表示する Plugin です。

導入

bash
npm install @riebeckite/plugin-gallery

Plugin の export 名や設定項目は、実装と package README を一次情報として確認してください。Riebeckite の Plugin は riebeckite.config.ts の plugins に登録して利用します。

使用例

複数の画像をまとめて紹介する記事で、画像一覧をギャラリーとして見せる用途に向いています。

ソース

markdown
```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
```

実行例

使いどころ

この Plugin が必要な場合だけ追加してください。Preset に含まれている場合は、同じ Plugin を重複して登録する必要はありません。

実際の表示例が用意されている場合は、Plugin Showcase でも確認できます。

詳細仕様

設定項目、公開 API、制約、追加の使用例は package README を参照してください。Plugin 全体の仕組みは Plugin System、Plugin を作る場合は Writing a Plugin を参照してください。

History

1 changesCollapseExpand
1 + # Gallery
2 +
3 + 複数の画像やメディアをギャラリーとして表示する Plugin です。
4 +
5 + ## 導入
6 +
7 + ```bash
8 + npm install @riebeckite/plugin-gallery
9 + ```
10 +
11 + Plugin の export 名や設定項目は、実装と package README を一次情報として確認してください。Riebeckite の Plugin は `riebeckite.config.ts` の `plugins` に登録して利用します。
12 +
13 + ## 使用例
14 +
15 + 複数の画像をまとめて紹介する記事で、画像一覧をギャラリーとして見せる用途に向いています。
16 +
17 + ### ソース
18 +
19 + ````markdown
20 + ```gallery
21 + columns: 3
22 + items:
23 + - title: Default
24 + description: A clean, typographic theme.
25 + href: https://riebeckite.dev/docs/themes/default
26 + - title: Minimal
27 + description: Stripped back to the essentials.
28 + href: https://riebeckite.dev/docs/themes/minimal
29 + - title: Gruvbox
30 + description: A warm, high-contrast palette.
31 + href: https://riebeckite.dev/docs/themes/gruvbox
32 + ```
33 + ````
34 +
35 + ### 実行例
36 +
37 + ```gallery
38 + columns: 3
39 + items:
40 + - title: Default
41 + description: A clean, typographic theme.
42 + href: https://riebeckite.dev/docs/themes/default
43 + - title: Minimal
44 + description: Stripped back to the essentials.
45 + href: https://riebeckite.dev/docs/themes/minimal
46 + - title: Gruvbox
47 + description: A warm, high-contrast palette.
48 + href: https://riebeckite.dev/docs/themes/gruvbox
49 + ```
50 +
51 + ## 使いどころ
52 +
53 + この Plugin が必要な場合だけ追加してください。Preset に含まれている場合は、同じ Plugin を重複して登録する必要はありません。
54 +
55 + 実際の表示例が用意されている場合は、[Plugin Showcase](./showcase.md) でも確認できます。
56 +
57 + ## 詳細仕様
58 +
59 + 設定項目、公開 API、制約、追加の使用例は package README を参照してください。Plugin 全体の仕組みは [Plugin System](../framework/plugin-system.md)、Plugin を作る場合は [Writing a Plugin](./writing-a-plugin.md) を参照してください。
60 +
61 +