@riebeckite/plugin-flashcards 0.0.32 → 0.0.33

package/README.md

@@ -27,11 +27,11 @@ and replaces them with an interactive deck.
 
 ```ts
 import { defineConfig } from "@riebeckite/core";
-import { flashcardsPlugin } from "@riebeckite/plugin-flashcards";
+import { flashcards } from "@riebeckite/plugin-flashcards";
 
 export default defineConfig({
   // ...
-  plugins: [flashcardsPlugin()],
+  plugins: [flashcards()],
 });
 ```
 
@@ -58,6 +58,15 @@ It stays readable without JavaScript.
 A block with no cards, a card without `::`, or a card with an empty side is
 reported as a diagnostic (`invalid-flashcards`) and left as a code block.
 
+## Live example
+
+~~~flashcards
+What is Riebeckite? :: A tool that builds a static site from Markdown
+What is the unit of publishing? :: A note
+~~~
+
+Without JavaScript the cards remain readable as a static list.
+
 ## Output
 
 At build time the block becomes
@@ -106,7 +115,7 @@ untouched. No options are passed from the build to the client; the deck reads
 
 ## Exports
 
-- `flashcards(options?)` / `flashcardsPlugin(options?)` — plugin factory
+- `flashcards(options?)` / `flashcards(options?)` — plugin factory
 - `initFlashcards(root?)` — client initializer
 - `parseFlashcards(source)` — parse a block into cards
 - `splitFlashcardGroups(source)` — split a block into card groups

package/README_ja.md

@@ -2,19 +2,19 @@
 
 <!-- Generated from docs/docs/plugins/flashcards.ja.md. Edit the canonical documentation in docs/docs/plugins and run `pnpm docs:sync`. -->
 
-`flashcards` コードブロックを学習用のカードデッキに変えるプラグインです。質問を表示して答えをめくり、前後の移動とシャッフルができます。ビルド時には静的なリストを先に出力するため、JavaScript がなくても内容を読めます。
+`flashcards` コードブロックを学習用のカードデッキに変えるプラグインです。質問を表示し、カードをめくって答えを確認できます。前後の移動とシャッフルにも対応します。ビルド時には静的なリストを先に出力するため、JavaScript がなくても内容を読めます。
 
 [English](./README.md)
 
-## 設定する
+## 設定
 
 ```ts
 import { defineConfig } from "@riebeckite/core";
-import { flashcardsPlugin } from "@riebeckite/plugin-flashcards";
+import { flashcards } from "@riebeckite/plugin-flashcards";
 
 export default defineConfig({
   // ...
-  plugins: [flashcardsPlugin()],
+  plugins: [flashcards()],
 });
 ```
 
@@ -35,7 +35,16 @@ It stays readable without JavaScript.
 ```
 ````
 
-カードが 1 枚もない、`::` のないカードがある、どちらかの側が空である、といった場合は `invalid-flashcards` の診断を出し、コードブロックのまま残します。
+カードが 1 枚もない場合や、`::` のないカード、どちらかの側が空のカードがある場合は、`invalid-flashcards` の診断を出してコードブロックのまま残します。
+
+## 実行例
+
+~~~flashcards
+Riebeckite とは？ :: Markdown から静的サイトを作るツール
+公開の単位は？ :: ノート
+~~~
+
+JavaScript がなくても、カードは静的なリストとして読めます。
 
 ## 出力
 
@@ -55,11 +64,11 @@ It stays readable without JavaScript.
 </div>
 ```
 
-payload は実行されない JSON で、`<` `>` `&` はエスケープ済みです。カードの文言にこれらの文字が含まれていても script 要素を閉じることはできません。順序付きリストは JavaScript がない場合の代替表示です。
+ペイロードは実行されない JSON で、`<` `>` `&` はエスケープ済みです。カードの文言にこれらの文字が含まれていても script 要素を閉じることはできません。順序付きリストは JavaScript がない場合の代替表示です。
 
 ## クライアントの動作
 
-`initFlashcards()` は各 `[data-flashcards]` 要素の payload を読み、代替リストの上に操作できるデッキを組み立てます。対応している操作は次のとおりです。
+`initFlashcards()` は各 `[data-flashcards]` 要素のペイロードを読み、代替リストの上に操作できるデッキを組み立てます。対応している操作は次のとおりです。
 
 - 答えの表示・非表示
 - 前後のカードへの移動（端で折り返す）
@@ -67,7 +76,7 @@ payload は実行されない JSON で、`<` `>` `&` はエスケープ済みで
 - カード位置の表示
 - キーボード操作: `Space` で答えを表示、`ArrowLeft` / `ArrowRight` で移動
 
-成功するとルートに `data-flashcards="ready"` が付き、静的なリストは非表示になります。payload がない、または壊れている場合は代替表示をそのまま残します。ビルドからクライアントへオプションは渡しません。シャッフルの初期状態は `data-flashcards-shuffle` 属性で伝えます。
+成功するとルートに `data-flashcards="ready"` が付き、静的なリストは非表示になります。ペイロードがない、または壊れている場合は代替表示をそのまま残します。ビルドからクライアントへオプションは渡しません。シャッフルの初期状態は `data-flashcards-shuffle` 属性で伝えます。
 
 ## オプション
 
@@ -80,7 +89,7 @@ payload は実行されない JSON で、`<` `>` `&` はエスケープ済みで
 
 ## 主なエクスポート
 
-- `flashcards(options?)` / `flashcardsPlugin(options?)`: プラグインを作成する
+- `flashcards(options?)` / `flashcards(options?)`: プラグインを作成する
 - `initFlashcards(root?)`: クライアント側を初期化する
 - `parseFlashcards(source)`: ブロックをカードに分解する
 - `splitFlashcardGroups(source)`: ブロックをカードのまとまりに分割する

package/dist/index.d.ts

@@ -9,4 +9,3 @@ export type { FlashcardsRuntime } from "./src/runtime.js";
 export { createFlashcardsRuntime } from "./src/runtime.js";
 export type { FlashcardsCard, FlashcardsOptions, FlashcardsParseFailure, FlashcardsParseResult, FlashcardsParseSuccess, FlashcardsPayload, ResolvedFlashcardsOptions, } from "./src/types.js";
 export declare function flashcards(options?: FlashcardsOptions): import("@riebeckite/core").RiebeckitePlugin<FlashcardsOptions>;
-export declare const flashcardsPlugin: typeof flashcards;

package/dist/index.js

@@ -421,7 +421,6 @@ function flashcards(options = {}) {
     ]
   });
 }
-var flashcardsPlugin = flashcards;
 function validateFlashcardsOptions(options) {
   if (!options) return [];
   const issues = [];
@@ -449,7 +448,6 @@ export {
   decodeFlashcardsSource,
   encodeFlashcardsSource,
   flashcards,
-  flashcardsPlugin,
   initFlashcards,
   parseFlashcards,
   remarkFlashcards,

package/dist/src/remark.d.ts

@@ -1,6 +1,6 @@
 import type { Root } from "mdast";
-export declare const FLASHCARDS_DIAGNOSTIC_SOURCE = "@riebeckite/plugin-flashcards";
-export type RemarkFlashcardsOptions = {
+type RemarkFlashcardsOptions = {
     language?: string;
 };
 export declare function remarkFlashcards(options?: RemarkFlashcardsOptions): (tree: Root, file?: unknown) => void;
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@riebeckite/plugin-flashcards",
-  "version": "0.0.32",
+  "version": "0.0.33",
   "license": "Apache-2.0",
   "type": "module",
   "main": "./dist/index.js",
@@ -21,9 +21,9 @@
     "./style.css": "./style.css"
   },
   "dependencies": {
+    "@riebeckite/core": "0.0.33",
     "@types/mdast": "^4.0.4",
-    "unist-util-visit": "^5.1.0",
-    "@riebeckite/core": "0.0.32"
+    "unist-util-visit": "^5.1.0"
   },
   "publishConfig": {
     "access": "public"