Color mode

Bases

Obsidian Bases の内容を公開サイトで扱うための Plugin です。

導入

bash
npm install @riebeckite/plugin-bases

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

使用例

Obsidian Bases を利用して整理している情報を公開サイト側でも扱いたい場合に利用します。対応範囲はPluginの実装と package README を基準にしてください。

ソース

markdown
```base
filters:
  and:
    - file.hasTag("featured")
properties:
  file.name:
    displayName: Title
views:
  - type: table
    name: Featured
    limit: 10
```

実行例

Featured

Title
README.ja
README
HW
ドキュメント
Documentation
アクセシビリティ
Accessibility
Framework
Framework
architecture.ja
Base definition
filters:
  and:
    - file.hasTag("featured")
properties:
  file.name:
    displayName: Title
views:
  - type: table
    name: Featured
    limit: 10

使いどころ

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

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

詳細仕様

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

History

1 changesCollapseExpand
1 + # Bases
2 +
3 + Obsidian Bases の内容を公開サイトで扱うための Plugin です。
4 +
5 + ## 導入
6 +
7 + ```bash
8 + npm install @riebeckite/plugin-bases
9 + ```
10 +
11 + Plugin の export 名や設定項目は、実装と package README を一次情報として確認してください。Riebeckite の Plugin は `riebeckite.config.ts` の `plugins` に登録して利用します。
12 +
13 + ## 使用例
14 +
15 + Obsidian Bases を利用して整理している情報を公開サイト側でも扱いたい場合に利用します。対応範囲はPluginの実装と package README を基準にしてください。
16 +
17 + ### ソース
18 +
19 + ````markdown
20 + ```base
21 + filters:
22 + and:
23 + - file.hasTag("featured")
24 + properties:
25 + file.name:
26 + displayName: Title
27 + views:
28 + - type: table
29 + name: Featured
30 + limit: 10
31 + ```
32 + ````
33 +
34 + ### 実行例
35 +
36 + ```base
37 + filters:
38 + and:
39 + - file.hasTag("featured")
40 + properties:
41 + file.name:
42 + displayName: Title
43 + views:
44 + - type: table
45 + name: Featured
46 + limit: 10
47 + ```
48 +
49 + ## 使いどころ
50 +
51 + この Plugin が必要な場合だけ追加してください。Preset に含まれている場合は、同じ Plugin を重複して登録する必要はありません。
52 +
53 + 実際の表示例が用意されている場合は、[Plugin Showcase](./showcase.ja.md) でも確認できます。
54 +
55 + ## 詳細仕様
56 +
57 + 設定項目、公開 API、制約、追加の使用例は package README を参照してください。Plugin 全体の仕組みは [Plugin System](../framework/plugin-system.ja.md)、Plugin を作る場合は [Writing a Plugin](./writing-a-plugin.ja.md) を参照してください。
58 +
59 +