natsufrank/zotero-plugin-template
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

chore: doc lint

Browse Source
This commit is contained in:
windingwind 2023-12-28 10:43:23 +08:00
parent 7f6b7c54b2
commit 2839b3ac53
1 changed files with 52 additions and 52 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
doc/README-zhCN.md
View File

@ -206,10 +206,10 @@ Obsidian风格的指令输入模块，它通过接受文本来运行插件，并
使用 `npm start` 启动开发服务器，它将： 使用 `npm start` 启动开发服务器，它将：
* 在开发模式下预构建插件 - 在开发模式下预构建插件
* 启动 Zotero ，并让其从 `build/` 中加载插件 - 启动 Zotero ，并让其从 `build/` 中加载插件
* 打开开发者工具（devtool） - 打开开发者工具（devtool）
* 监听 `src/**` 和 `addon/**`. - 监听 `src/**` 和 `addon/**`.
- 如果 `src/**` 修改了，运行 esbuild 并且重新加载 - 如果 `src/**` 修改了，运行 esbuild 并且重新加载
- 如果 `addon/**` 修改了，(在开发模式下)重新构建插件并且重新加载 - 如果 `addon/**` 修改了，(在开发模式下)重新构建插件并且重新加载
@ -250,15 +250,15 @@ Obsidian风格的指令输入模块，它通过接受文本来运行插件，并
`scripts/build.mjs` 的运行步骤: `scripts/build.mjs` 的运行步骤:
* 创建/清空 `build/` - 创建/清空 `build/`
* 复制 `addon/**` 到 `build/addon/**` - 复制 `addon/**` 到 `build/addon/**`
* 替换占位符：使用 `replace-in-file` 去替换在 `package.json` 中定义的关键字和配置 (`xhtml`、`.flt` 等) - 替换占位符：使用 `replace-in-file` 去替换在 `package.json` 中定义的关键字和配置 (`xhtml`、`.flt` 等)
* 准备本地化文件以避免冲突，查看官方文档了解更多（https://www.zotero.org/support/dev/zotero_7_for_developers#avoiding_localization_conflicts） - 准备本地化文件以避免冲突，查看官方文档了解更多（https://www.zotero.org/support/dev/zotero_7_for_developers#avoiding_localization_conflicts）
* 重命名`**/*.flt` 为 `**/${addonRef}-*.flt` - 重命名`**/*.flt` 为 `**/${addonRef}-*.flt`
* 在每个消息前加上 `addonRef-` - 在每个消息前加上 `addonRef-`
* 使用 Esbuild 来将 `.ts` 源码构建为 `.js`，从 `src/index.ts` 构建到`./build/addon/chrome/content/scripts` - 使用 Esbuild 来将 `.ts` 源码构建为 `.js`，从 `src/index.ts` 构建到`./build/addon/chrome/content/scripts`
* (仅在生产模式下工作) 压缩 `./build/addon` 目录为 `./build/*.xpi` - (仅在生产模式下工作) 压缩 `./build/addon` 目录为 `./build/*.xpi`
* (仅在生产模式下工作) 准备 `update.json` 或 `update-beta.json` - (仅在生产模式下工作) 准备 `update.json` 或 `update-beta.json`
> [!note] > [!note]
> >