@riebeckite/plugin-sidenotes 0.0.32 → 0.0.33

package/README.md

@@ -61,6 +61,12 @@ To render margin notes instead:
 plugins: [sidenotes({ placement: "margin" })];
 ```
 
+## Live example
+
+A footnote reference appears here.[^live-example]
+
+[^live-example]: The note is rendered by the sidenotes plugin.
+
 ## Options
 
 | Option | Type | Default | Description |
@@ -133,7 +139,7 @@ Stable hooks follow the `rr-sidenotes` convention: `rr-sidenotes__toggle`,
 ## Exports
 
 - `sidenotes(options?)` — plugin factory
-- `sidenotesPlugin` — alias of `sidenotes`
+- `sidenotes` — alias of `sidenotes`
 - `rehypeSidenotes(options?)` — the rehype transformer
 - `resolveSidenotesOptions(options?)` — apply option defaults
 - `renderSidenotesReference(input)` / `renderSidenotesNote(input)` — HTML builders

package/README_ja.md

@@ -2,17 +2,13 @@
 
 <!-- Generated from docs/docs/plugins/sidenotes.ja.md. Edit the canonical documentation in docs/docs/plugins and run `pnpm docs:sync`. -->
 
-Riebeckite 用の脚注スタイル・プラグインです。執筆者は通常の GFM 脚注
-（`[^1]` と `[^1]: 本文`）をそのまま書き続けます。既定では脚注定義は記事末尾の
-脚注リストに残ります。`placement: "margin"` を指定すると、Tufte スタイルの
-マージンノートとして参照の横に表示します。
+Riebeckite 用の脚注スタイルプラグインです。執筆者は通常の GFM 脚注（`[^1]` と `[^1]: 本文`）をそのまま書き続けます。既定では脚注定義は記事末尾の脚注リストに残ります。`placement: "margin"` を指定すると、Tufte スタイルのマージンノートとして参照の横に表示します。
 
 [English](./README.md)
 
 ## 仕組み
 
-このプラグインは、`remark-gfm` の出力をコアのパイプラインが脚注マークアップ
-に変換したものを、rehype プラグインで読み取ります。
+このプラグインは、コアのパイプラインが `remark-gfm` の出力を脚注マークアップに変換した後、rehype プラグインとしてそれを読み取ります。
 
 既定の `placement: "end"` では:
 
@@ -61,6 +57,12 @@ Riebeckite は脚注を記事末尾のリストに表示します。[^1]
 plugins: [sidenotes({ placement: "margin" })];
 ```
 
+## 実行例
+
+ここに脚注への参照を置きます。[^live-example]
+
+[^live-example]: この注釈は sidenotes プラグインが描画します。
+
 ## オプション
 
 | オプション | 型 | 既定値 | 説明 |
@@ -133,7 +135,7 @@ import "@riebeckite/plugin-sidenotes/style.css";
 ## エクスポート
 
 - `sidenotes(options?)`：プラグインファクトリ
-- `sidenotesPlugin`：`sidenotes` のエイリアス
+- `sidenotes`：`sidenotes` のエイリアス
 - `rehypeSidenotes(options?)`：rehype トランスフォーマー
 - `resolveSidenotesOptions(options?)`：オプションの既定値を適用する
 - `renderSidenotesReference(input)` / `renderSidenotesNote(input)`：HTML 生成関数
@@ -145,8 +147,7 @@ import "@riebeckite/plugin-sidenotes/style.css";
   します。
 - マージン配置では、文末の脚注定義セクションは DOM に残りますが非表示に
   なります。テーマは `.rr-sidenotes__note` を自由に再スタイルできます。
-- テーブル内や深く入れ子になったインライン要素の中の注は、最も近いブロック
-  要素の後ろに置かれるため、縦位置はおおよその位置になります。
+- テーブル内や深く入れ子になったインライン要素の中の注記は、最も近いブロック要素の後ろに置かれるため、縦位置はおおよその位置になります。
 
 ## 関連リンク
 

package/dist/index.d.ts

@@ -11,5 +11,3 @@ export declare const SIDENOTES_PLUGIN_NAME = "sidenotes";
  * markup into an inline reference plus a margin note.
  */
 export declare function sidenotes(options?: SidenotesOptions): import("@riebeckite/core").RiebeckitePlugin<SidenotesOptions>;
-/** Alias matching the `*Plugin` suffix used by other plugin factories. */
-export declare const sidenotesPlugin: typeof sidenotes;

package/dist/index.js

@@ -400,7 +400,6 @@ function sidenotes(options = {}) {
     ]
   });
 }
-var sidenotesPlugin = sidenotes;
 function validateSidenotesOptions(options) {
   if (!options) return [];
   const issues = [];
@@ -427,6 +426,5 @@ export {
   resolveSidenotesOptions,
   sidenotes,
   sidenotesKey,
-  sidenotesNoteId,
-  sidenotesPlugin
+  sidenotesNoteId
 };

package/dist/src/options.d.ts

@@ -1,7 +1,4 @@
 import type { ResolvedSidenotesOptions, SidenotesOptions } from "./types.js";
-export declare const DEFAULT_SIDENOTES_ARIA_LABEL = "Sidenote";
-export declare const DEFAULT_SIDENOTES_OPEN_LABEL = "Footnote";
-export declare const DEFAULT_SIDENOTES_PLACEMENT = "end";
 /**
  * Applies defaults to `SidenotesOptions`. Pure and deterministic so the
  * plugin can resolve options once and reuse them for every processed tree.

package/dist/src/render.d.ts

@@ -2,17 +2,13 @@ import type { HastNode, ResolvedSidenotesOptions } from "./types.js";
 /** Feature hooks follow the `rr-sidenotes` convention from the CSS hooks doc. */
 export declare const SIDENOTES_REF_CLASS = "rr-sidenotes__ref";
 export declare const SIDENOTES_TOGGLE_CLASS = "rr-sidenotes__toggle";
-export declare const SIDENOTES_NOTE_CLASS = "rr-sidenotes__note";
-export declare const SIDENOTES_INDEX_CLASS = "rr-sidenotes__index";
-export declare const SIDENOTES_BODY_CLASS = "rr-sidenotes__body";
 export declare const SIDENOTES_FOOTNOTES_CLASS = "rr-sidenotes__footnotes";
-export declare const SIDENOTES_NOTE_ID_PREFIX = "rr-sidenotes-";
 /** Extracts the footnote key from a reference href. Returns `null` when the
  * href does not look like a footnote target. */
 export declare function sidenotesKey(href: string): string | null;
 /** Stable id shared by a sidenote and its reference links. */
 export declare function sidenotesNoteId(key: string): string;
-export type SidenotesReferenceInput = {
+type SidenotesReferenceInput = {
     /** Existing `href` of the GFM footnote reference, used when no key exists. */
     href: string;
     /** Existing `id` of the GFM footnote reference, kept for back-links. */
@@ -27,7 +23,7 @@ export type SidenotesReferenceInput = {
  * so it can reuse the existing wrapper when one is already present.
  */
 export declare function renderSidenotesReference(input: SidenotesReferenceInput): string;
-export type SidenotesNoteInput = {
+type SidenotesNoteInput = {
     key: string;
     index: string;
     /** Serialized definition content (back-links stripped). */
@@ -42,3 +38,4 @@ export declare function renderSidenotesNote(input: SidenotesNoteInput): string;
  * every text value and attribute is escaped here.
  */
 export declare function renderHastChildren(children: readonly HastNode[]): string;
+export {};

package/dist/src/types.d.ts

@@ -37,7 +37,7 @@ export type HastElementNode = {
     properties?: Record<string, unknown>;
     children?: HastNode[];
 };
-export type HastTextNode = {
+type HastTextNode = {
     type: "text";
     value: string;
 };
@@ -46,17 +46,18 @@ export type HastRawNode = {
     type: "raw";
     value: string;
 };
-export type HastCommentNode = {
+type HastCommentNode = {
     type: "comment";
     value: string;
 };
-export type HastDoctypeNode = {
+type HastDoctypeNode = {
     type: "doctype";
     name?: string;
 };
-export type HastRootNode = {
+type HastRootNode = {
     type: "root";
     children?: HastNode[];
 };
 /** Any node the sidenotes transformer may encounter in a hast tree. */
 export type HastNode = HastElementNode | HastTextNode | HastRawNode | HastCommentNode | HastDoctypeNode | HastRootNode;
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@riebeckite/plugin-sidenotes",
-  "version": "0.0.32",
+  "version": "0.0.33",
   "license": "Apache-2.0",
   "type": "module",
   "main": "./dist/index.js",
@@ -15,7 +15,7 @@
     "./style.css": "./style.css"
   },
   "dependencies": {
-    "@riebeckite/core": "0.0.32"
+    "@riebeckite/core": "0.0.33"
   },
   "publishConfig": {
     "access": "public"
@@ -50,6 +50,7 @@
     "./style.css"
   ],
   "scripts": {
-    "build": "node ../../../scripts/build_package.mjs"
+    "build": "node ../../../scripts/build_package.mjs",
+    "test": "node --import tsx --test \"test/*.test.ts\""
   }
 }