# markdown

**Repository Path**: null_187_9028/markdown

## Basic Information

- **Project Name**: markdown
- **Description**: 一款自己开发的markdown软件，方便查看md文档，不使用三方软件，不需要激活。
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-07-22
- **Last Updated**: 2026-07-24

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Markdown Reader

Windows 桌面 Markdown 阅读器：所见即所得编辑 + 图表沉浸缩放拖动。

## 开发

```bash
npm install
# 若 electron 二进制未下载成功（国内网络）：
#   set ELECTRON_MIRROR=https://npmmirror.com/mirrors/electron/
#   node node_modules/electron/install.js

# PlantUML（可选但推荐）
npm run fetch:plantuml
# 便携 JRE（无本机 JDK 时）
# npm run fetch:jre

npm run dev
```

打开应用后加载 `fixtures/mixed.md` / `fixtures/plantuml-demo.md` 验收。

本机已有 JDK 时可设 `JAVA_HOME`（如 `C:\Program Files\Java\jdk-17`），不必拉便携 JRE。

## 功能（S0–S8）

- 打开 / 保存本地 `.md`，多标签，最近打开
- TipTap 所见即所得（GFM、任务列表、代码高亮、大纲）
- Mermaid / Graphviz / PlantUML 渲染 + 沉浸缩放拖动
- KaTeX 公式；导出 HTML / PDF（文件菜单）
- **查看 → 暗色模式**；**检查/应用引擎更新**（Engine Pack）
- NSIS 一键安装包（见下方「打包」）

### PlantUML

```bash
npm run fetch:plantuml   # → engines/bundled/plantuml/plantuml.jar
```

Java 解析顺序：便携 `runtime/jre` → `JAVA_HOME` → PATH。

### 引擎热更新（本地联调）

```bash
npm run pack:engines
set ENGINE_UPDATE_URL=D:\trae-workspace\markdown\engines\remote\latest-stable.json
npm run dev
```

菜单：**查看 → 检查引擎更新 / 应用引擎更新**。断网时保留现有引擎。

## 打包安装包（完整命令）

国内网络建议先设镜像，再拉取运行时并打 NSIS 安装包：

```bash
REM 1）可选镜像（PowerShell / cmd）
set ELECTRON_MIRROR=https://npmmirror.com/mirrors/electron/
set ELECTRON_BUILDER_BINARIES_MIRROR=https://npmmirror.com/mirrors/electron-builder-binaries/
set CSC_IDENTITY_AUTO_DISCOVERY=false

REM 2）拉取 PlantUML jar + 便携 JRE（安装包离线跑 PlantUML 需要）
npm run fetch:runtime

REM 3）构建并产出 Setup.exe
npm run dist
```

分步等价命令：

```bash
npm run fetch:plantuml
npm run fetch:jre
npm run build
npx electron-builder --config electron-builder.yml --win nsis
```

产物路径：

- `release/MarkdownReader-Setup-x64.exe` — 双击即可安装
- `release/win-unpacked/` — 免安装调试目录（可选：`npm run dist:dir`）

说明：

- `npm run dist` 会检查 `engines/bundled/manifest.json`、`plantuml.jar`、`runtime/jre/bin/java.exe`，缺则自动拉取或失败退出。
- 若本机无「开发者模式」/管理员权限，构建配置已关闭 `signAndEditExecutable`，避免 winCodeSign 符号链接失败。
- 安装包体积约百余 MB（含 Electron + 引擎 + JRE）；**不入库**（Gitee 单文件上限 100MB），请本地执行上述命令生成。
- 安装后可将 Markdown Reader 设为 `.md` 默认打开方式；应用为**单实例**：已有窗口时再双击会在同一窗口新开/切换标签，并打开对应文件。

## 设计文档

见 `docs/design/` 与 `docs/requirements/`。