From 439c2134b6f4bd41ab51db1da6a41b4c7413a04c Mon Sep 17 00:00:00 2001 From: frostime Date: Tue, 30 May 2023 21:39:25 +0800 Subject: [PATCH] =?UTF-8?q?=E6=9B=B4=E6=96=B0=20README=EF=BC=8C=E6=8C=87?= =?UTF-8?q?=E6=98=8E=20node=20=E7=89=88=E6=9C=AC=E5=9C=A8=2018=20=E4=BB=A5?= =?UTF-8?q?=E4=B8=8A?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 6 ++++-- README_zh_CN.md | 7 +++++-- 2 files changed, 9 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 6bee855..352ada8 100644 --- a/README.md +++ b/README.md @@ -20,7 +20,7 @@ - Notice: we **don't recommand** you to place the folder under your `{workspace}/data/plugins/` folder. 3. Install NodeJS and pnpm, then run pnpm i in the command line under your repo folder -4. **Auto create development symbolic links** +4. **Auto create development symbolic links** (requires nodejs over version 18) - Make sure that SiYuan is running - Run `pnpm run make-link`, the script will detect all the siyuan workspace, please select the targe workspace and the script will automatically create the symbolic link under the `{workspace}/data/plugins/` folder ```bash @@ -36,7 +36,7 @@ Got target directory: H:\Media\SiYuan/data/plugins Done! Created symlink H:\Media\SiYuan/data/plugins/plugin-sample-vite-svelte ``` -4. **Manually create development symbolic links** +4. **Manually create development symbolic links** (requires nodejs over version 18) - Open `./scripts/make_dev_link.js` file, set `targetDir` to your SiYuan plugin directory `/data/plugins` - Run `pnpm run make-link`, succeed if following message is shown: ```bash @@ -50,6 +50,8 @@ 5. Execute pnpm run dev for real-time compilation 6. Open SiYuan marketplace and enable plugin in downloaded tab +> Notice: as the `make-link` script rely on the `fetch` function, please **ensure that at least version v18 of nodejs is installed** if you want to use make-link script. + ## I18n In terms of internationalization, our main consideration is to support multiple languages. Specifically, we need to diff --git a/README_zh_CN.md b/README_zh_CN.md index 86a27a9..f1b02db 100644 --- a/README_zh_CN.md +++ b/README_zh_CN.md @@ -17,7 +17,7 @@ 2. 将你的库克隆到本地开发文件夹中 * 注意: 同 `plugin-sample` 不同, 本样例并不推荐直接把代码下载到 `{workspace}/data/plugins/` 3. 安装 [NodeJS](https://nodejs.org/en/download) 和 [pnpm](https://pnpm.io/installation),然后在开发文件夹下执行 `pnpm i` 安装所需要的依赖 -4. **自动创建符号链接** +3. **自动创建符号链接** (需要 nodejs 版本在 18 以上) - 打开思源笔记, 确保思源内核正在运行 - 运行 `pnpm run make-link`, 脚本会自动检测所有思源的工作空间, 请在命令行中手动输入序号以选择工作空间 ```bash @@ -33,7 +33,7 @@ Got target directory: H:\Media\SiYuan/data/plugins Done! Created symlink H:\Media\SiYuan/data/plugins/plugin-sample-vite-svelte ``` -4. **手动创建符号链接** +4. **手动创建符号链接** (需要 nodejs 版本在 18 以上) - 打开 `./scripts/make_dev_link.js` 文件,更改 `targetDir` 为思源的插件目录 `/data/plugins` - 运行 `pnpm run make-link` 命令, 如果看到类似以下的消息,说明创建成功: ```bash @@ -47,6 +47,9 @@ 6. 在思源中打开集市并在下载选项卡中启用插件 +> 注意由于使用的 make-link 脚本依赖于 `fetch`,所以如果想要使用 make-link **请保证至少安装 v18 版本的 nodejs** + + ## 国际化 国际化方面我们主要考虑的是支持多语言,具体需要完成以下工作: