Riebeckite
Menu
Color mode

Alias

ノートに設定した別名をコンテンツの参照や表示に利用するための Plugin です。

導入

bash
npm install @riebeckite/plugin-alias

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

使用例

同じ記事に別名を持たせ、Obsidian 側の呼び名と公開時の参照を扱いやすくしたい場合に利用します。

yaml
---
aliases:
  - Riebeckite入門
  - Riebeckite Guide
---

ビルドすると、エイリアスの URL から正規 URL への 308 リダイレクトが生成されます。URL の正規化も行い、クライアント側の JavaScript は必要ありません。

使いどころ

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

詳細仕様

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

History

1 changesCollapseExpand
1 + # Alias
2 +
3 + ノートに設定した別名をコンテンツの参照や表示に利用するための Plugin です。
4 +
5 + ## 導入
6 +
7 + ```bash
8 + npm install @riebeckite/plugin-alias
9 + ```
10 +
11 + Plugin の export 名や設定項目は、実装と package README を一次情報として確認してください。Riebeckite の Plugin は `riebeckite.config.ts` の `plugins` に登録して利用します。
12 +
13 + ## 使用例
14 +
15 + 同じ記事に別名を持たせ、Obsidian 側の呼び名と公開時の参照を扱いやすくしたい場合に利用します。
16 +
17 + ```yaml
18 + ---
19 + aliases:
20 + - Riebeckite入門
21 + - Riebeckite Guide
22 + ---
23 + ```
24 +
25 + ビルドすると、エイリアスの URL から正規 URL への 308 リダイレクトが生成されます。URL の正規化も行い、クライアント側の JavaScript は必要ありません。
26 +
27 + ## 使いどころ
28 +
29 + この Plugin が必要な場合だけ追加してください。Preset に含まれている場合は、同じ Plugin を重複して登録する必要はありません。
30 +
31 + ## 詳細仕様
32 +
33 + 設定項目、公開 API、制約、追加の使用例は package README を参照してください。Plugin 全体の仕組みは [Plugin System](../framework/plugin-system.ja.md)、Plugin を作る場合は [Writing a Plugin](./writing-a-plugin.ja.md) を参照してください。
34 +
35 +