@b4moss/hyogen-md 0.10.0 → 0.10.1
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.
- package/README.md +18 -10
- package/README_ja.md +18 -10
- package/package.json +9 -7
package/README.md
CHANGED
|
@@ -2,10 +2,12 @@
|
|
|
2
2
|
|
|
3
3
|
|
|
4
4
|
|
|
5
|
-
[](https://github.com/b4moss/hyogen-md/actions/workflows/ci.yml)
|
|
6
|
+
[](https://codecov.io/gh/b4moss/hyogen-md)
|
|
7
|
+
[](https://www.npmjs.com/package/@b4moss/hyogen-md)
|
|
8
|
+
[](https://github.com/b4moss/hyogen-md/releases)
|
|
9
|
+
[](https://github.com/b4moss/hyogen-md/blob/main/LICENSE)
|
|
10
|
+
[](https://securityscorecards.dev/viewer/?uri=github.com/b4moss/hyogen-md)
|
|
9
11
|
|
|
10
12
|
Extended Markdown template engine for TypeScript / JavaScript.
|
|
11
13
|
|
|
@@ -16,6 +18,8 @@ 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)
|
|
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)
|
|
19
23
|
- **Specs (Japanese, maintainers):** [dev-docs/](https://github.com/b4m-oss/hyogen-md/tree/develop/dev-docs)
|
|
20
24
|
|
|
21
25
|
> **Homepage:** [https://github.com/b4m-oss/hyogen-md](https://github.com/b4m-oss/hyogen-md)
|
|
@@ -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
|
-
| `
|
|
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
101
|
| `dev-docs/` | Specs and roadmap (**Japanese**, maintainers) |
|
|
98
102
|
|
|
99
|
-
###
|
|
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
|
-
|
|
103
|
-
|
|
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
|
|
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
|
|
|
4
4
|
|
|
5
|
-
[](https://github.com/b4moss/hyogen-md/actions/workflows/ci.yml)
|
|
6
|
+
[](https://codecov.io/gh/b4moss/hyogen-md)
|
|
7
|
+
[](https://www.npmjs.com/package/@b4moss/hyogen-md)
|
|
8
|
+
[](https://github.com/b4moss/hyogen-md/releases)
|
|
9
|
+
[](https://github.com/b4moss/hyogen-md/blob/main/LICENSE)
|
|
10
|
+
[](https://securityscorecards.dev/viewer/?uri=github.com/b4moss/hyogen-md)
|
|
9
11
|
|
|
10
12
|
TypeScript / JavaScript 向けの拡張 Markdown テンプレートエンジンです。
|
|
11
13
|
|
|
@@ -16,6 +18,8 @@ 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)
|
|
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 非同梱）
|
|
19
23
|
- **仕様（日本語・メンテナー向け）:** [dev-docs/](https://github.com/b4m-oss/hyogen-md/tree/develop/dev-docs)
|
|
20
24
|
|
|
21
25
|
> **Homepage:** [https://github.com/b4m-oss/hyogen-md](https://github.com/b4m-oss/hyogen-md)
|
|
@@ -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
|
-
| `
|
|
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
101
|
| `dev-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
|
-
|
|
103
|
-
|
|
104
|
-
npm run dev
|
|
111
|
+
make install-docs
|
|
112
|
+
make dev-docs
|
|
105
113
|
```
|
|
106
114
|
|
|
107
|
-
Vite alias で `../app`
|
|
115
|
+
`http://localhost:3000`（ドキュメント）と `/playground`。Vite alias で `../app` を参照。仮想 FS + `localStorage` のみ。
|
|
108
116
|
|
|
109
117
|
---
|
|
110
118
|
|
package/package.json
CHANGED
|
@@ -1,17 +1,17 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@b4moss/hyogen-md",
|
|
3
|
-
"version": "0.10.
|
|
3
|
+
"version": "0.10.1",
|
|
4
4
|
"description": "Extended Markdown template engine (hyogen.md)",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"license": "MIT",
|
|
7
7
|
"author": "Kohki SHIKATA <kohki.shikata@gmail.com>",
|
|
8
|
-
"homepage": "https://github.com/
|
|
8
|
+
"homepage": "https://github.com/b4moss/hyogen-md",
|
|
9
9
|
"repository": {
|
|
10
10
|
"type": "git",
|
|
11
|
-
"url": "git+https://github.com/
|
|
11
|
+
"url": "git+https://github.com/b4moss/hyogen-md.git"
|
|
12
12
|
},
|
|
13
13
|
"bugs": {
|
|
14
|
-
"url": "https://github.com/
|
|
14
|
+
"url": "https://github.com/b4moss/hyogen-md/issues"
|
|
15
15
|
},
|
|
16
16
|
"keywords": [
|
|
17
17
|
"markdown",
|
|
@@ -45,9 +45,10 @@
|
|
|
45
45
|
"scripts": {
|
|
46
46
|
"build": "vite build && vite build --config vite.client.config.ts",
|
|
47
47
|
"typecheck": "tsc -p tsconfig.json --noEmit",
|
|
48
|
-
"test": "vitest run",
|
|
48
|
+
"test": "vitest run --coverage",
|
|
49
49
|
"test:watch": "vitest",
|
|
50
|
-
"dev": "vite build --watch"
|
|
50
|
+
"dev": "vite build --watch",
|
|
51
|
+
"test:coverage": "vitest run --coverage"
|
|
51
52
|
},
|
|
52
53
|
"devDependencies": {
|
|
53
54
|
"@types/node": "^26.1.1",
|
|
@@ -56,7 +57,8 @@
|
|
|
56
57
|
"typescript": "^5.9.2",
|
|
57
58
|
"vite": "^7.0.6",
|
|
58
59
|
"vite-plugin-dts": "^4.5.4",
|
|
59
|
-
"vitest": "^3.2.4"
|
|
60
|
+
"vitest": "^3.2.4",
|
|
61
|
+
"@vitest/coverage-v8": "^3"
|
|
60
62
|
},
|
|
61
63
|
"engines": {
|
|
62
64
|
"node": ">=20"
|