MarkEasy:一个 HTML 文件就能跑的 Markdown 编辑器,写长文终于不用折腾编号了

2026-05-21 33 预计阅读时间:1 分钟
来源:oschina.net AI 摘要 原文链接

免责声明:本文为 AI 摘要整理,建议结合原文阅读。摘要可能省略上下文、版本差异或边界条件,不作为官方说明。

预计阅读时间:7 分钟

写技术文档最烦的不是内容本身,而是格式——标题编号手动维护、表格排版对不齐、公式渲染靠插件、导出 PDF 还得装工具链。MarkEasy 把这些事压进了一个 HTML 文件,浏览器打开就能用,离线也不受影响。

单文件架构意味着什么

MarkEasy 的整个编辑器就是一个 HTML 页面。没有 Node 依赖、没有构建步骤、没有 npm install。下载下来丢到任意目录,双击用浏览器打开,立刻进入编辑状态。

这对几种场景特别友好:

  • 内网环境或受限机器上写文档,装不了额外软件
  • 临时在别人电脑上改一份 Markdown,不想留配置痕迹
  • 把编辑器随项目一起分发,团队成员零门槛上手

单文件的代价是体积稍大(所有 JS/CSS 内联),但换来的是真正的"即开即用"。你甚至可以把它放进 Git 仓库的 docs/ 目录,克隆下来就能编辑项目文档。

所见即所得,表格可以直接点着改

大多数 Markdown 编辑器要么是纯文本+侧栏预览,要么像 Typora 那样实时渲染但编辑区不可控。MarkEasy 走的是双栏路线:左边写源码,右边实时预览,但预览区的表格单元格可以直接点击编辑,改动同步回左侧源码。

写复杂表格时这个体验差距很明显——纯文本里对齐列宽是件痛苦的事:

| 模块     | 负责人 | 状态   | 备注         |
| -------- | ------ | ------ | ------------ |
| 用户认证 | 张三   | 已完成 | 需加双因子   |
| 数据同步 | 李四   | 开发中 | 依赖消息队列 |
| 报表导出 | 王五   | 待启动 | 等需求终审   |

在 MarkEasy 里,你直接在预览区点进"备注"那列改文字,不用数空格对齐竖线。改完左侧源码自动更新,省了反复调格式的时间。

大纲导航 + 自动编号,长篇文档的救命功能

写超过 10 个标题的技术方案或设计文档时,手动编 1.11.22.1 很容易出错——中间插一节,后面的编号全得改。MarkEasy 的标题自动编号直接解决了这个问题:

# 系统架构设计

## 前端层
### 路由模块
### 状态管理

## 服务层
### 认证服务
### 业务逻辑

## 数据层

渲染后自动变成:

1 系统架构设计
  1.1 前端层
    1.1.1 路由模块
    1.1.2 状态管理
  1.2 服务层
    1.2.1 认证服务
    1.2.2 业务逻辑
  1.3 数据层

左侧还有大纲导航面板,点击任意标题跳转到对应位置。几十页的文档不用再滚半天找章节。

Mermaid 流程图和代码高亮

技术文档里画流程图是刚需。MarkEasy 内置 Mermaid 支持,直接在 Markdown 里写声明式图表:

```mermaid
flowchart TD
    A[客户端请求] --> B{网关鉴权}
    B -->|通过| C[路由分发]
    B -->|拒绝| D[返回 401]
    C --> E[业务服务]
    E --> F[数据持久化]
    F --> G[响应客户端]
渲染出来就是一张完整的流程图,不用另外用 draw.io 画再导出图片插入。改逻辑只需改文本,图自动更新。

代码块同样有语法高亮,写技术博客或 API 文档时体验完整:

```markdown
```python
def retry_with_backoff(fn, max_retries=3, base_delay=1.0):
    for attempt in range(max_retries):
        try:
            return fn()
        except Exception as e:
            if attempt == max_retries - 1:
                raise
            delay = base_delay * (2 ** attempt)
            time.sleep(delay)
## 导出:HTML / PDF / Markdown 三选一

写完文档,一键导出。HTML 导出带完整样式,直接发链接就能看;PDF 导出中文排版工整,不用再调字体;Markdown 导出保留自动编号,方便放进其他系统。

实际操作路径:编辑器右上角导出按钮  选择格式  下载。PDF 导出依赖浏览器打印引擎,建议用 Chrome 以获得最佳排版效果。

## 实践:把 MarkEasy 嵌进项目文档工作流

一个典型用法是把 MarkEasy 放进项目仓库,配合简单脚本实现"编辑 → 导出 → 提交"的闭环:

```bash
# 项目目录结构
mkdir -p docs && cd docs

# 下载 MarkEasy(假设仓库地址,替换为实际 release 地址)
curl -L -o markeasy.html https://github.com/example/markeasy/releases/latest/download/markeasy.html

# 把它加进仓库
git add markeasy.html
git commit -m "add markdown editor to docs"

# 以后任何人克隆项目后
open markeasy.html        # macOS
# 或 xdg-open markeasy.html  # Linux
# 或直接双击文件              # Windows

写完文档导出 HTML 版本,放进项目的 public/ 目录就能当静态站点用:

# 导出为 HTML 后移到静态目录
mkdir -p public
cp design-doc.html public/
# 如果用 GitHub Pages,push 后自动发布
git add public/design-doc.html
git commit -m "publish design doc"
git push

适合谁,不适合谁

MarkEasy 的定位很清晰——轻量、单机、即用。它适合:

  • 个人写技术博客、设计文档、周报
  • 小团队内部文档编辑,不想搭 Confluence 或 GitBook
  • 需要离线写文档的场景(出差、断网环境)

但它不适合:

  • 多人实时协作编辑(没有后端,没有同步机制)
  • 大规模文档站点管理(没有目录结构、搜索、版本对比)
  • 需要自定义主题或深度插件扩展的场景

如果你只是想安安静静写一份排版干净的技术文档,不想折腾工具链,MarkEasy 是目前最省事的选择之一——一个 HTML 文件,浏览器打开,写完导出,关掉走人。


相关推荐