Article Metadata
記事の公開日・更新日・読了時間・タクソノミーのタグを、記事コンテキストから描画するプラグインです。
実行例
このページのタイトルの下にある公開日・読了時間の行が、ここで描画されています。<time> 要素には機械可読な日付が入ります。タグがあるノートではタグも表示されます。
できること
articleMetadata() はコンポーネントのスタイルシートを登録します。ルートの追加や Markdown 本文の変更は行いません。
サイトは、メタデータを表示したい位置でコンポーネントを描画します。
import ArticleMetadata from "@riebeckite/plugin-article-metadata/components";
<ArticleMetadata locale="ja-JP" />;
コンポーネントは記事コンテキストから現在の記事を読み取ります。公開日は published、date、created の順に採用し、updated、計算した読了時間、tags も描画します。記事コンテキストがない場合は何も描画しません。
タグのリンクはタクソノミープラグインの解決済み設定を使うため、独自の tagsBasePath にも追随します。タグページが無効な場合はタグをテキストで表示します。サイトコンテキストがない場合もテキスト表示です。
オプション
| Prop | 既定値 | 説明 |
|---|---|---|
locale |
"en-US" |
Intl.DateTimeFormat に渡すロケール。 |
labels.published |
"PUBLISHED" |
公開日のラベル。 |
labels.updated |
"UPDATED" |
更新日のラベル。 |
labels.read |
"READ" |
読了時間のラベル。 |
labels.tags |
"Tags" |
タグ一覧のアクセシブルなラベル。 |
スタイル
コンポーネントは rr-article-metadata をルートに、rr-article-metadata__* を要素に使います。テーマはこれらのフックで見た目を変更できます。