@riebeckite/plugin-related-posts 0.0.21 → 0.0.22

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/README.md +6 -13
  2. package/README_ja.md +6 -13
  3. package/package.json +3 -3
package/README.md CHANGED
@@ -1,5 +1,7 @@
1
1
  # @riebeckite/plugin-related-posts
2
2
 
3
+ <!-- Generated from docs/docs/plugins/related-posts.md. Edit the canonical documentation in docs/docs/plugins and run `pnpm docs:sync`. -->
4
+
3
5
  Build-time "related notes" navigation. For every published entry, the plugin
4
6
  ranks the other entries in the content manifest and contributes a related-posts
5
7
  section to the `article.footer` Slot. No client-side JavaScript is required.
@@ -81,18 +83,9 @@ relatedPosts({
81
83
  });
82
84
  ```
83
85
 
84
- ## Output
85
-
86
- ```html
87
- <nav class="rb-related-posts" data-related-posts>
88
- <h2 class="rb-related-posts__heading">Related</h2>
89
- <ul>
90
- <li class="rb-related-posts__item">
91
- <a class="rb-related-posts__link" href="/notes/example" data-related-score="5">Example Note</a>
92
- </li>
93
- </ul>
94
- </nav>
95
- ```
86
+ ## Display
87
+
88
+ Related entries are rendered in the `article.footer` slot on eligible pages. This site renders the live navigation below the article when matching public entries exist.
96
89
 
97
90
  ## Style
98
91
 
@@ -120,4 +113,4 @@ import "@riebeckite/plugin-related-posts/style.css";
120
113
 
121
114
  ## See also
122
115
 
123
- - [Plugin guide](../../../docs/docs/reference/plugin-api.md)
116
+ - [Plugin guide](https://github.com/Rerurate514/riebeckite/blob/main/docs/docs/reference/plugin-api.md)
package/README_ja.md CHANGED
@@ -1,5 +1,7 @@
1
1
  # @riebeckite/plugin-related-posts
2
2
 
3
+ <!-- Generated from docs/docs/plugins/related-posts.ja.md. Edit the canonical documentation in docs/docs/plugins and run `pnpm docs:sync`. -->
4
+
3
5
  ビルド時に「関連ノート」ナビゲーションを生成するプラグインです。公開対象の
4
6
  各エントリについて、コンテンツマニフェスト上の他のエントリをスコア順に並べ、
5
7
  関連ノートのセクションを `article.footer` Slot に追加します。クライアント側 JavaScript は
@@ -73,18 +75,9 @@ relatedPosts({
73
75
  });
74
76
  ```
75
77
 
76
- ## 出力
77
-
78
- ```html
79
- <nav class="rb-related-posts" data-related-posts>
80
- <h2 class="rb-related-posts__heading">Related</h2>
81
- <ul>
82
- <li class="rb-related-posts__item">
83
- <a class="rb-related-posts__link" href="/notes/example" data-related-score="5">Example Note</a>
84
- </li>
85
- </ul>
86
- </nav>
87
- ```
78
+ ## 表示
79
+
80
+ 関連エントリは対象ページの `article.footer` スロットに描画されます。このサイトでは、条件に合う公開エントリがあれば記事下に実際のナビゲーションを表示します。
88
81
 
89
82
  ## スタイル
90
83
 
@@ -112,4 +105,4 @@ import "@riebeckite/plugin-related-posts/style.css";
112
105
 
113
106
  ## 関連リンク
114
107
 
115
- - [プラグイン API](../../../docs/docs/reference/plugin-api.ja.md)
108
+ - [プラグイン API](https://github.com/Rerurate514/riebeckite/blob/main/docs/docs/reference/plugin-api.ja.md)
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@riebeckite/plugin-related-posts",
3
- "version": "0.0.21",
3
+ "version": "0.0.22",
4
4
  "license": "Apache-2.0",
5
5
  "type": "module",
6
6
  "main": "./dist/index.js",
@@ -22,11 +22,11 @@
22
22
  },
23
23
  "dependencies": {
24
24
  "hono": "^4.12.25",
25
- "@riebeckite/core": "0.0.21"
25
+ "@riebeckite/core": "0.0.22"
26
26
  },
27
27
  "devDependencies": {
28
28
  "tsx": "^4.22.4",
29
- "@riebeckite/test": "0.0.21"
29
+ "@riebeckite/test": "0.0.22"
30
30
  },
31
31
  "publishConfig": {
32
32
  "access": "public"