@riebeckite/plugin-changelog 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 -19
  2. package/README_ja.md +6 -19
  3. package/package.json +2 -2
package/README.md CHANGED
@@ -1,5 +1,7 @@
1
1
  # @riebeckite/plugin-changelog
2
2
 
3
+ <!-- Generated from docs/docs/plugins/changelog.md. Edit the canonical documentation in docs/docs/plugins and run `pnpm docs:sync`. -->
4
+
3
5
  Build-time change history derived from local Git history. For every published
4
6
  note the plugin adds a "change history" section with commit dates, subjects,
5
7
  and authors, and it can build a site-wide changelog dataset from the notes'
@@ -59,23 +61,9 @@ export default defineConfig({
59
61
  | `siteWideHeading` | `string` | `"Changelog"` | Site-wide heading text |
60
62
  | `className` | `string` | `"rr-changelog"` | Root CSS class |
61
63
 
62
- ## Output
63
-
64
- The plugin appends a fragment like this to the `article.after-content` slot:
65
-
66
- ```html
67
- <section class="rr-changelog rr-changelog--note" data-changelog-note>
68
- <h2 class="rr-changelog__heading">Change history</h2>
69
- <ol class="rr-changelog__list">
70
- <li class="rr-changelog__item">
71
- <time class="rr-changelog__date" datetime="2026-09-30T09:00:00+09:00">2026-09-30</time>
72
- <span class="rr-changelog__subject">Fix the sidebar offset</span>
73
- <span class="rr-changelog__author">Author Name</span>
74
- <code class="rr-changelog__hash" title="…full hash…">abc1234</code>
75
- </li>
76
- </ol>
77
- </section>
78
- ```
64
+ ## Display
65
+
66
+ The plugin appends each note's change history to the `article.after-content` slot. When enabled, it is rendered after the article on eligible pages.
79
67
 
80
68
  `data-changelog-note` and `data-changelog-site` mark the two fragments for
81
69
  styling and idempotency checks.
@@ -152,5 +140,4 @@ import "@riebeckite/plugin-changelog/style.css";
152
140
  ## See also
153
141
 
154
142
  - [plugin-diff](../diff/README.md) — revision history and line diffs
155
- - [Plugin guide](../../../docs/docs/reference/plugin-api.md)
156
-
143
+ - [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-changelog
2
2
 
3
+ <!-- Generated from docs/docs/plugins/changelog.ja.md. Edit the canonical documentation in docs/docs/plugins and run `pnpm docs:sync`. -->
4
+
3
5
  ローカル Git の履歴からビルド時に変更履歴を生成するプラグインです。公開ノートごとにコミット日・件名・作成者を並べた「変更履歴」セクションを追加し、サイト全体の変更履歴データセットも組み立てられます。クライアント JavaScript は不要です。
4
6
 
5
7
  [English](./README.md)
@@ -48,23 +50,9 @@ export default defineConfig({
48
50
  | `siteWideHeading` | `string` | `"Changelog"` | サイト全体の見出し文言 |
49
51
  | `className` | `string` | `"rr-changelog"` | ルート CSS クラス |
50
52
 
51
- ## 出力
52
-
53
- `article.after-content` スロットに次のような断片を追加します。
54
-
55
- ```html
56
- <section class="rr-changelog rr-changelog--note" data-changelog-note>
57
- <h2 class="rr-changelog__heading">Change history</h2>
58
- <ol class="rr-changelog__list">
59
- <li class="rr-changelog__item">
60
- <time class="rr-changelog__date" datetime="2026-09-30T09:00:00+09:00">2026-09-30</time>
61
- <span class="rr-changelog__subject">Fix the sidebar offset</span>
62
- <span class="rr-changelog__author">Author Name</span>
63
- <code class="rr-changelog__hash" title="…完全なハッシュ…">abc1234</code>
64
- </li>
65
- </ol>
66
- </section>
67
- ```
53
+ ## 表示
54
+
55
+ ノートごとの変更履歴は `article.after-content` スロットへ追加され、有効にした対象ページの記事下で実際に描画されます。
68
56
 
69
57
  `data-changelog-note` と `data-changelog-site` は、2 種類の断片をスタイリングと重複防止のために識別する属性です。
70
58
 
@@ -122,5 +110,4 @@ import "@riebeckite/plugin-changelog/style.css";
122
110
  ## 関連資料
123
111
 
124
112
  - [plugin-diff](../diff/README_ja.md) — リビジョン履歴と行差分
125
- - [プラグインシステム](../../../docs/docs/reference/plugin-api.ja.md)
126
-
113
+ - [プラグインシステム](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-changelog",
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",
@@ -15,7 +15,7 @@
15
15
  "./style.css": "./style.css"
16
16
  },
17
17
  "dependencies": {
18
- "@riebeckite/core": "0.0.21"
18
+ "@riebeckite/core": "0.0.22"
19
19
  },
20
20
  "devDependencies": {
21
21
  "@types/node": "^24.5.2",