# markdown阅读器

**Repository Path**: toolssh/markdown-reader

## Basic Information

- **Project Name**: markdown阅读器
- **Description**: 一个简单的markdown阅读器
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-12-29
- **Last Updated**: 2025-12-29

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Markdown Reader (Electron)

一个简单、干净的 Electron Markdown 阅读器：左侧 Markdown 文本，右侧实时预览。

## 功能

- 左侧 Markdown，右侧渲染结果
- `Ctrl/Cmd + O` 打开本地 `.md` 文件
- 支持拖拽 `.md` 文件到窗口直接打开
- 点击预览区链接会在默认浏览器打开

## 运行

需要本机已安装 Node.js。

```bash
npm install
npm start
```

也可以在启动时直接打开某个文件：

```bash
npm start -- path\to\file.md
```

## 打包（Windows）

```bash
npm install
npm run dist
```

打包完成后在 `dist/` 里会生成安装包；安装后可以在资源管理器里直接双击 `.md` 文件用本软件打开（也可以右键“打开方式”选择并设为默认）。

## 软件图标（从 SVG 生成）

把你的 `renderer/logo.svg` 作为源文件，执行：

```bash
npm run icons
```

会生成：

- `build/icon.ico`（Windows 安装包/EXE 图标）
- `build/icon.png`（通用 PNG）

## 说明

为了避免依赖下载失败，本项目未引入第三方 Markdown 解析库，内置了一个“够用”的轻量解析（标题/列表/引用/代码块/加粗/斜体/行内代码/链接/分割线）。