@mirascript/help 0.1.64 → 0.1.65
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 +6 -6
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -1,16 +1,16 @@
|
|
|
1
1
|
# @mirascript/help
|
|
2
2
|
|
|
3
|
-
`@mirascript/help`
|
|
3
|
+
`@mirascript/help` 将仓库文档编译为可直接消费的帮助数据，主要用于编辑器提示、站点展示和文档检索。
|
|
4
4
|
|
|
5
5
|
## 数据来源
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
构建过程会读取 `docs/references` 下的文档，并基于 front-matter 中的 `token`、`title` 等字段生成产物。
|
|
8
8
|
|
|
9
|
-
##
|
|
9
|
+
## 主要导出
|
|
10
10
|
|
|
11
11
|
- `KEYWORDS`：关键字到 Markdown 文本的映射
|
|
12
12
|
- `OPERATORS`：运算符到 Markdown 文本的映射
|
|
13
|
-
- `Keyword` / `Operator
|
|
13
|
+
- `Keyword` / `Operator`：由生成结果推导的字面量类型
|
|
14
14
|
|
|
15
15
|
## 安装
|
|
16
16
|
|
|
@@ -18,7 +18,7 @@
|
|
|
18
18
|
pnpm add @mirascript/help
|
|
19
19
|
```
|
|
20
20
|
|
|
21
|
-
##
|
|
21
|
+
## 快速开始
|
|
22
22
|
|
|
23
23
|
```ts
|
|
24
24
|
import { KEYWORDS, OPERATORS } from '@mirascript/help';
|
|
@@ -33,4 +33,4 @@ console.log(OPERATORS['??']);
|
|
|
33
33
|
pnpm --filter @mirascript/help build
|
|
34
34
|
```
|
|
35
35
|
|
|
36
|
-
|
|
36
|
+
当 `docs/references` 内容变更后，请重新构建以刷新 `dist/`。
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@mirascript/help",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.65",
|
|
4
4
|
"author": "CloudPSS",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"description": "Help documentation for Mirascript core language.",
|
|
@@ -25,7 +25,7 @@
|
|
|
25
25
|
"./package.json": "./package.json"
|
|
26
26
|
},
|
|
27
27
|
"devDependencies": {
|
|
28
|
-
"js-yaml": "^5.2.
|
|
28
|
+
"js-yaml": "^5.2.1"
|
|
29
29
|
},
|
|
30
30
|
"scripts": {
|
|
31
31
|
"build": "pnpm clean && node ./scripts/build.js",
|