thzxx
05e5667e48
feat(editor): 将 Milkdown/ProseMirror 替换为 @metona-team/metona-editor v0.1.3 - 三模式视图 (edit/split/preview) 由编辑器内置工具栏切换 - searchReplace + imagePaste 预设插件 - unified/rehype 渲染管线通过 render 钩子集成 - 主题双向同步 (应用暗色模式 ↔ 编辑器主题) feat(toast): metona-toast 迁移为 @metona-team/metona-toast v2.0.1 refactor: 删除冗余组件与代码 - 移除 SourceEditor、Preview、SearchReplace、EditorToolbar、useMilkdown - 移除 StatusBar 组件及状态栏扩展架构（编辑器内置底栏替代） - 移除 useSettings、useStatusBarItem、useStatusBarItems、statusBarStore - 移除 EditMode/PreviewMode/SourceMode 图标 refactor(ui): 简化布局 - 工具栏移除模式切换按钮，新增自动保存开关 - useKeyboard 移除 Ctrl+1/2/3/B/I 快捷键 - Editor 三模式统一由 MetonaEditor 容器渲染 chore: 版本号 v0.3.13 → v0.4.0 docs: 全面更新 README/DESIGN/CONTRIBUTING/DEVSETUP
94 lines
3.3 KiB
Markdown
94 lines
3.3 KiB
Markdown
# MarkLite v0.4.0 — 开发环境配置指南
|
||
|
||
以下涵盖从 Node 版本管理、镜像源配置到 electron-builder 打包的全流程。
|
||
|
||
## 一、Node 版本管理（nvm）
|
||
|
||
安装 nvm-windows 后，使用以下命令管理 Node 版本：
|
||
|
||
```bash
|
||
# 安装需要的版本（以 Node 18 为例）
|
||
nvm install 18
|
||
|
||
# 设为当前终端使用的版本
|
||
nvm use 18
|
||
|
||
# 设为默认版本（新终端自动生效）
|
||
nvm alias default 18
|
||
```
|
||
|
||
## 二、配置镜像源
|
||
|
||
npm v9+ 已不支持 `npm config set` 设置自定义键名，必须直接编辑 `.npmrc` 文件。
|
||
|
||
### 项目级 .npmrc（推荐）
|
||
|
||
在项目根目录下创建或编辑 `.npmrc` 文件，写入以下内容：
|
||
|
||
```
|
||
registry=https://registry.npmmirror.com
|
||
@metona-team:registry=https://git.metona.cn/api/packages/MetonaTeam/npm/
|
||
//git.metona.cn/api/packages/MetonaTeam/npm/:_auth=<your_token>
|
||
//git.metona.cn/api/packages/MetonaTeam/npm/:always-auth=true
|
||
|
||
# Electron 二进制下载镜像
|
||
ELECTRON_MIRROR=https://npmmirror.com/mirrors/electron/
|
||
ELECTRON_BUILDER_BINARIES_MIRROR=https://npmmirror.com/mirrors/electron-builder-binaries/
|
||
```
|
||
|
||
> 注：`@metona-team` scope 指向 MetonaTeam 私有 npm registry，用于安装 `@metona-team/metona-editor` 和 `@metona-team/metona-toast`。如需使用公开版本可参考 `.npmrc.example`。
|
||
|
||
如果想让所有项目都生效，编辑全局 `.npmrc`（可通过 `npm config get userconfig` 查看路径），内容同上。
|
||
|
||
## 三、配置文件说明
|
||
|
||
| 配置项 | 作用 |
|
||
|:-------|:-----|
|
||
| `registry` | npm 包下载源，避免从 npmjs.org 拉包缓慢 |
|
||
| `@metona-team:registry` | MetonaTeam 私有包 scope registry |
|
||
| `ELECTRON_MIRROR` | Electron 二进制文件（electron.exe 等）的下载源 |
|
||
| `ELECTRON_BUILDER_BINARIES_MIRROR` | electron-builder 打包工具链的下载源 |
|
||
|
||
## 四、开始打包
|
||
|
||
> **关键：** 保存 `.npmrc` 后务必新开一个命令行窗口，否则环境变量不生效。
|
||
|
||
```bash
|
||
# 1. 清除旧缓存，确保不走之前的错误源
|
||
npm cache clean --force
|
||
|
||
# 2. 安装依赖（如果还没装或 node_modules 不完整）
|
||
npm install
|
||
|
||
# 3. 执行构建
|
||
npm run build
|
||
```
|
||
|
||
构建成功后，安装包会生成在 `dist/` 目录下。
|
||
|
||
## 五、一次性完整操作步骤总结
|
||
|
||
```bash
|
||
# ① 确保 Node 版本正确
|
||
nvm use 18
|
||
|
||
# ② 在项目根目录创建 .npmrc，写入：
|
||
# registry=https://registry.npmmirror.com
|
||
# @metona-team:registry=https://git.metona.cn/api/packages/MetonaTeam/npm/
|
||
# //git.metona.cn/api/packages/MetonaTeam/npm/:_auth=<token>
|
||
# ELECTRON_MIRROR=https://npmmirror.com/mirrors/electron/
|
||
# ELECTRON_BUILDER_BINARIES_MIRROR=https://npmmirror.com/mirrors/electron-builder-binaries/
|
||
|
||
# ③ 关闭当前终端，新开一个终端，然后执行：
|
||
npm cache clean --force
|
||
npm install
|
||
npm run build
|
||
```
|
||
|
||
## 六、常见问题排查
|
||
|
||
- **`ELECTRON_MIRROR is not a valid npm option`**：npm 版本太新，禁止用 `npm config set` 设置自定义键，改用编辑 `.npmrc` 文件解决。
|
||
- **`@metona-team` 包安装失败**：检查 `.npmrc` 中 `@metona-team:registry` 和认证 token 配置是否正确。
|
||
- **下载 Electron 还是走 GitHub**：检查 `.npmrc` 文件名是否正确（不要写成 `.npmrc.txt`），以及是否重新打开了终端。
|
||
- **nvm 切换版本后 node 没变**：确保以管理员身份运行终端，且 nvm 安装路径没有中文或空格。
|