@riebeckite/plugin-breadcrumbs 0.0.20 → 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 -20
  2. package/README_ja.md +6 -20
  3. package/package.json +3 -3
package/README.md CHANGED
@@ -1,5 +1,7 @@
1
1
  # @riebeckite/plugin-breadcrumbs
2
2
 
3
+ <!-- Generated from docs/docs/plugins/breadcrumbs.md. Edit the canonical documentation in docs/docs/plugins and run `pnpm docs:sync`. -->
4
+
3
5
  Build-time breadcrumb navigation derived from the note's slug hierarchy. For
4
6
  every published entry the plugin inserts a `<nav>` at the top of the rendered
5
7
  HTML and enriches the page with a hierarchical BreadcrumbList JSON-LD schema.
@@ -68,25 +70,9 @@ breadcrumbs({
68
70
  });
69
71
  ```
70
72
 
71
- ## Output
72
-
73
- ```html
74
- <nav class="rb-breadcrumbs" data-breadcrumbs aria-label="Breadcrumbs">
75
- <ol>
76
- <li class="rb-breadcrumbs__item">
77
- <a class="rb-breadcrumbs__link" href="/">Blog</a>
78
- <span class="rb-breadcrumbs__separator" aria-hidden="true">/</span>
79
- </li>
80
- <li class="rb-breadcrumbs__item">
81
- <a class="rb-breadcrumbs__link" href="/folder">Folder</a>
82
- <span class="rb-breadcrumbs__separator" aria-hidden="true">/</span>
83
- </li>
84
- <li class="rb-breadcrumbs__item">
85
- <span class="rb-breadcrumbs__current" aria-current="page">Note</span>
86
- </li>
87
- </ol>
88
- </nav>
89
- ```
73
+ ## Display
74
+
75
+ Breadcrumbs are rendered above the article on every eligible page. This page shows the live navigation for its own path.
90
76
 
91
77
  ## Style
92
78
 
@@ -114,4 +100,4 @@ import "@riebeckite/plugin-breadcrumbs/style.css";
114
100
 
115
101
  ## See also
116
102
 
117
- - [Plugin guide](../../../docs/docs/reference/plugin-api.md)
103
+ - [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-breadcrumbs
2
2
 
3
+ <!-- Generated from docs/docs/plugins/breadcrumbs.ja.md. Edit the canonical documentation in docs/docs/plugins and run `pnpm docs:sync`. -->
4
+
3
5
  ノートのスラッグ階層からパンくずナビゲーションをビルド時に生成する
4
6
  プラグインです。公開対象の各エントリについて、記事上部に `<nav>` を挿入し、
5
7
  階層構造を反映した BreadcrumbList の JSON-LD も出力します。クライアント側
@@ -67,25 +69,9 @@ breadcrumbs({
67
69
  });
68
70
  ```
69
71
 
70
- ## 出力
71
-
72
- ```html
73
- <nav class="rb-breadcrumbs" data-breadcrumbs aria-label="Breadcrumbs">
74
- <ol>
75
- <li class="rb-breadcrumbs__item">
76
- <a class="rb-breadcrumbs__link" href="/">ブログ</a>
77
- <span class="rb-breadcrumbs__separator" aria-hidden="true">/</span>
78
- </li>
79
- <li class="rb-breadcrumbs__item">
80
- <a class="rb-breadcrumbs__link" href="/folder">フォルダ</a>
81
- <span class="rb-breadcrumbs__separator" aria-hidden="true">/</span>
82
- </li>
83
- <li class="rb-breadcrumbs__item">
84
- <span class="rb-breadcrumbs__current" aria-current="page">ノート</span>
85
- </li>
86
- </ol>
87
- </nav>
88
- ```
72
+ ## 表示
73
+
74
+ パンくずは対象ページの記事上部に描画されます。このページでも、自身のパスに対応するナビゲーションを確認できます。
89
75
 
90
76
  ## スタイル
91
77
 
@@ -113,4 +99,4 @@ import "@riebeckite/plugin-breadcrumbs/style.css";
113
99
 
114
100
  ## 関連リンク
115
101
 
116
- - [プラグイン API](../../../docs/docs/reference/plugin-api.ja.md)
102
+ - [プラグイン 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-breadcrumbs",
3
- "version": "0.0.20",
3
+ "version": "0.0.22",
4
4
  "license": "Apache-2.0",
5
5
  "type": "module",
6
6
  "main": "./dist/index.js",
@@ -15,11 +15,11 @@
15
15
  "./style.css": "./style.css"
16
16
  },
17
17
  "dependencies": {
18
- "@riebeckite/core": "0.0.20"
18
+ "@riebeckite/core": "0.0.22"
19
19
  },
20
20
  "devDependencies": {
21
21
  "tsx": "^4.22.4",
22
- "@riebeckite/test": "0.0.20"
22
+ "@riebeckite/test": "0.0.22"
23
23
  },
24
24
  "publishConfig": {
25
25
  "access": "public"