@b4moss/hyogen-md 0.10.0 → 0.11.0

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 (6) hide show
  1. package/README.md +22 -14
  2. package/README_ja.md +22 -14
  3. package/dist/client.js +473 -469
  4. package/dist/index.d.ts +14 -0
  5. package/dist/index.js +477 -332
  6. package/package.json +11 -8
package/README.md CHANGED
@@ -2,10 +2,12 @@
2
2
 
3
3
  ![masthead](https://raw.githubusercontent.com/b4m-oss/hyogen-md/develop/user-docs/hyogen-md-masthead.png)
4
4
 
5
- [![npm version](https://img.shields.io/npm/v/@b4moss/hyogen-md.svg)](https://www.npmjs.com/package/@b4moss/hyogen-md)
6
- [![license](https://img.shields.io/github/license/b4m-oss/hyogen-md)](./LICENSE)
7
- [![node](https://img.shields.io/node/v/@b4moss/hyogen-md.svg)](https://www.npmjs.com/package/@b4moss/hyogen-md)
8
- [![coverage](https://img.shields.io/badge/coverage-84%25-brightgreen)](#status)
5
+ [![CI](https://github.com/b4moss/hyogen-md/actions/workflows/ci.yml/badge.svg)](https://github.com/b4moss/hyogen-md/actions/workflows/ci.yml)
6
+ [![Coverage](https://img.shields.io/codecov/c/github/b4moss/hyogen-md)](https://codecov.io/gh/b4moss/hyogen-md)
7
+ [![npm](https://img.shields.io/npm/v/@b4moss/hyogen-md)](https://www.npmjs.com/package/@b4moss/hyogen-md)
8
+ [![Release](https://img.shields.io/github/v/release/b4moss/hyogen-md)](https://github.com/b4moss/hyogen-md/releases)
9
+ [![License](https://img.shields.io/github/license/b4moss/hyogen-md)](https://github.com/b4moss/hyogen-md/blob/main/LICENSE)
10
+ [![OpenSSF Scorecard](https://api.scorecard.dev/projects/github.com/b4moss/hyogen-md/badge)](https://scorecard.dev/viewer/?uri=github.com/b4moss/hyogen-md)
9
11
 
10
12
  Extended Markdown template engine for TypeScript / JavaScript.
11
13
 
@@ -16,7 +18,9 @@ Control flow and templating live in HTML comments (`@hg` … `@endhg` or `@@`
16
18
  - **License:** MIT
17
19
  - **Japanese README:** [README_ja.md](./README_ja.md)
18
20
  - **Changelog:** [user-docs/changelog.md](https://github.com/b4m-oss/hyogen-md/blob/develop/user-docs/changelog.md)
19
- - **Specs (Japanese, maintainers):** [dev-docs/](https://github.com/b4m-oss/hyogen-md/tree/develop/dev-docs)
21
+ - **Documentation:** [https://hyogenmd.oss.b4m.jp](https://hyogenmd.oss.b4m.jp) (Nuxt Content; not in npm)
22
+ - **Playground:** [https://hyogenmd.oss.b4m.jp/playground](https://hyogenmd.oss.b4m.jp/playground) (same site; not in npm)
23
+ - **Specs (Japanese, maintainers):** [docs/](https://github.com/b4m-oss/hyogen-md/tree/develop/docs)
20
24
 
21
25
  > **Homepage:** [https://github.com/b4m-oss/hyogen-md](https://github.com/b4m-oss/hyogen-md)
22
26
 
@@ -30,7 +34,7 @@ This file is kept **in sync** at the repository root and at `app/README.md` (npm
30
34
  npm install @b4moss/hyogen-md
31
35
  ```
32
36
 
33
- Requires **Node.js >= 20**.
37
+ Requires **Node.js >= 24**.
34
38
 
35
39
  ---
36
40
 
@@ -83,7 +87,7 @@ const { files, warnings } = await build({
83
87
  });
84
88
  ```
85
89
 
86
- API details: [dev-docs/specs/api.md](https://github.com/b4m-oss/hyogen-md/blob/develop/dev-docs/specs/api.md).
90
+ API details: [docs/specs/api.md](https://github.com/b4m-oss/hyogen-md/blob/develop/docs/specs/api.md).
87
91
 
88
92
  ---
89
93
 
@@ -92,19 +96,23 @@ API details: [dev-docs/specs/api.md](https://github.com/b4m-oss/hyogen-md/blob/d
92
96
  | Path | Role |
93
97
  |------|------|
94
98
  | `app/` | Library published to npm (`files`: `dist`, plus README / LICENSE) |
95
- | `playground/` | Local Vite + Vue playground (**not** published to npm) |
99
+ | `docs-site/` | Documentation site + Playground on [GitHub Pages](https://hyogenmd.oss.b4m.jp) (**not** in npm) |
96
100
  | `user-docs/` | User-facing docs (e.g. [changelog](https://github.com/b4m-oss/hyogen-md/blob/develop/user-docs/changelog.md)) |
97
- | `dev-docs/` | Specs and roadmap (**Japanese**, maintainers) |
101
+ | `docs/` | Specs and roadmap (**Japanese**, maintainers) |
98
102
 
99
- ### Playground (local only)
103
+ ### Documentation & Playground
104
+
105
+ **Site:** **[https://hyogenmd.oss.b4m.jp](https://hyogenmd.oss.b4m.jp)** (GitHub Pages; `/ja`, `/en`, `/playground`).
106
+ **Playground:** **[https://hyogenmd.oss.b4m.jp/playground](https://hyogenmd.oss.b4m.jp/playground)**
107
+
108
+ Local:
100
109
 
101
110
  ```bash
102
- cd playground
103
- npm install
104
- npm run dev
111
+ make install-docs
112
+ make dev-docs
105
113
  ```
106
114
 
107
- Uses `../app` via Vite alias. Virtual FS + `localStorage` only (no real disk I/O).
115
+ Open `http://localhost:3000` (docs) and `/playground`. Uses `../app` via Vite alias. Virtual FS + `localStorage` only.
108
116
 
109
117
  ---
110
118
 
package/README_ja.md CHANGED
@@ -2,10 +2,12 @@
2
2
 
3
3
  ![masthead](https://raw.githubusercontent.com/b4m-oss/hyogen-md/develop/user-docs/hyogen-md-masthead.png)
4
4
 
5
- [![npm version](https://img.shields.io/npm/v/@b4moss/hyogen-md.svg)](https://www.npmjs.com/package/@b4moss/hyogen-md)
6
- [![license](https://img.shields.io/github/license/b4m-oss/hyogen-md)](./LICENSE)
7
- [![node](https://img.shields.io/node/v/@b4moss/hyogen-md.svg)](https://www.npmjs.com/package/@b4moss/hyogen-md)
8
- [![coverage](https://img.shields.io/badge/coverage-84%25-brightgreen)](#ステータス)
5
+ [![CI](https://github.com/b4moss/hyogen-md/actions/workflows/ci.yml/badge.svg)](https://github.com/b4moss/hyogen-md/actions/workflows/ci.yml)
6
+ [![Coverage](https://img.shields.io/codecov/c/github/b4moss/hyogen-md)](https://codecov.io/gh/b4moss/hyogen-md)
7
+ [![npm](https://img.shields.io/npm/v/@b4moss/hyogen-md)](https://www.npmjs.com/package/@b4moss/hyogen-md)
8
+ [![Release](https://img.shields.io/github/v/release/b4moss/hyogen-md)](https://github.com/b4moss/hyogen-md/releases)
9
+ [![License](https://img.shields.io/github/license/b4moss/hyogen-md)](https://github.com/b4moss/hyogen-md/blob/main/LICENSE)
10
+ [![OpenSSF Scorecard](https://api.scorecard.dev/projects/github.com/b4moss/hyogen-md/badge)](https://scorecard.dev/viewer/?uri=github.com/b4moss/hyogen-md)
9
11
 
10
12
  TypeScript / JavaScript 向けの拡張 Markdown テンプレートエンジンです。
11
13
 
@@ -16,7 +18,9 @@ TypeScript / JavaScript 向けの拡張 Markdown テンプレートエンジン
16
18
  - **ライセンス:** MIT
17
19
  - **English README:** [README.md](./README.md)
18
20
  - **Changelog:** [user-docs/changelog_ja.md](https://github.com/b4m-oss/hyogen-md/blob/develop/user-docs/changelog_ja.md)
19
- - **仕様（日本語・メンテナー向け）:** [dev-docs/](https://github.com/b4m-oss/hyogen-md/tree/develop/dev-docs)
21
+ - **ドキュメントサイト:** [https://hyogenmd.oss.b4m.jp](https://hyogenmd.oss.b4m.jp)（Nuxt Content。npm 非同梱）
22
+ - **Playground:** [https://hyogenmd.oss.b4m.jp/playground](https://hyogenmd.oss.b4m.jp/playground)（同一サイト。npm 非同梱）
23
+ - **仕様（日本語・メンテナー向け）:** [docs/](https://github.com/b4m-oss/hyogen-md/tree/develop/docs)
20
24
 
21
25
  > **Homepage:** [https://github.com/b4m-oss/hyogen-md](https://github.com/b4m-oss/hyogen-md)
22
26
 
@@ -30,7 +34,7 @@ TypeScript / JavaScript 向けの拡張 Markdown テンプレートエンジン
30
34
  npm install @b4moss/hyogen-md
31
35
  ```
32
36
 
33
- **Node.js >= 20** が必要です。
37
+ **Node.js >= 24** が必要です。
34
38
 
35
39
  ---
36
40
 
@@ -83,7 +87,7 @@ const { files, warnings } = await build({
83
87
  });
84
88
  ```
85
89
 
86
- API の詳細: [dev-docs/specs/api.md](https://github.com/b4m-oss/hyogen-md/blob/develop/dev-docs/specs/api.md)。
90
+ API の詳細: [docs/specs/api.md](https://github.com/b4m-oss/hyogen-md/blob/develop/docs/specs/api.md)。
87
91
 
88
92
  ---
89
93
 
@@ -92,19 +96,23 @@ API の詳細: [dev-docs/specs/api.md](https://github.com/b4m-oss/hyogen-md/blob
92
96
  | パス | 役割 |
93
97
  |------|------|
94
98
  | `app/` | npm 公開するライブラリ（`dist` + README / LICENSE） |
95
- | `playground/` | ローカル向け Vite + Vue プレイグラウンド（**npm 非同梱**） |
99
+ | `docs-site/` | [GitHub Pages](https://hyogenmd.oss.b4m.jp) 上のドキュメントサイト + Playground（**npm 非同梱**） |
96
100
  | `user-docs/` | 利用者向けドキュメント（例: [changelog](https://github.com/b4m-oss/hyogen-md/blob/develop/user-docs/changelog_ja.md)） |
97
- | `dev-docs/` | 仕様・ロードマップ（**日本語**・メンテナー向け） |
101
+ | `docs/` | 仕様・ロードマップ（**日本語**・メンテナー向け） |
98
102
 
99
- ### プレイグラウンド（ローカルのみ）
103
+ ### ドキュメントサイト & Playground
104
+
105
+ **サイト:** **[https://hyogenmd.oss.b4m.jp](https://hyogenmd.oss.b4m.jp)**（GitHub Pages。`/ja`・`/en`・`/playground`）
106
+ **Playground:** **[https://hyogenmd.oss.b4m.jp/playground](https://hyogenmd.oss.b4m.jp/playground)**
107
+
108
+ ローカル:
100
109
 
101
110
  ```bash
102
- cd playground
103
- npm install
104
- npm run dev
111
+ make install-docs
112
+ make dev-docs
105
113
  ```
106
114
 
107
- Vite alias で `../app` を参照します。仮想 FS + `localStorage` のみ（実ディスクは使いません）。
115
+ `http://localhost:3000`（ドキュメント）と `/playground`。Vite alias で `../app` を参照。仮想 FS + `localStorage` のみ。
108
116
 
109
117
  ---
110
118