Riebeckite
Menu
Color mode

Query

コンテンツに対するクエリ結果をページ内へ表示するための Plugin です。

導入

bash
npm install @riebeckite/plugin-query

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

使用例

コンテンツのメタデータなどを条件にして、該当する記事群を取り出して表示したい場合に利用します。たとえば特定タグの記事一覧や条件付きのコンテンツ一覧を作る用途です。

ソース

markdown
```query
sort:
  field: title
  order: asc
limit: 5
```

実行例

TitleDate
Accessibility
alias
alias.en
analytics
analytics

使いどころ

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

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

詳細仕様

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

History

1 changesCollapseExpand
1 + # Query
2 +
3 + コンテンツに対するクエリ結果をページ内へ表示するための Plugin です。
4 +
5 + ## 導入
6 +
7 + ```bash
8 + npm install @riebeckite/plugin-query
9 + ```
10 +
11 + Plugin の export 名や設定項目は、実装と package README を一次情報として確認してください。Riebeckite の Plugin は `riebeckite.config.ts` の `plugins` に登録して利用します。
12 +
13 + ## 使用例
14 +
15 + コンテンツのメタデータなどを条件にして、該当する記事群を取り出して表示したい場合に利用します。たとえば特定タグの記事一覧や条件付きのコンテンツ一覧を作る用途です。
16 +
17 + ### ソース
18 +
19 + ````markdown
20 + ```query
21 + sort:
22 + field: title
23 + order: asc
24 + limit: 5
25 + ```
26 + ````
27 +
28 + ### 実行例
29 +
30 + ```query
31 + sort:
32 + field: title
33 + order: asc
34 + limit: 5
35 + ```
36 +
37 + ## 使いどころ
38 +
39 + この Plugin が必要な場合だけ追加してください。Preset に含まれている場合は、同じ Plugin を重複して登録する必要はありません。
40 +
41 + 実際の表示例が用意されている場合は、[Plugin Showcase](./showcase.md) でも確認できます。
42 +
43 + ## 詳細仕様
44 +
45 + 設定項目、公開 API、制約、追加の使用例は package README を参照してください。Plugin 全体の仕組みは [Plugin System](../framework/plugin-system.md)、Plugin を作る場合は [Writing a Plugin](./writing-a-plugin.md) を参照してください。
46 +
47 +