返回资讯中心
外部精选
软件工程
#开发者实时流

OpenMarkdown Editor:直接编辑 Markdown 源码的实时预览编辑器

来源标题:Show HN: OpenMarkdown Editor – edits Markdown source, not a document tree

OpenMarkdown Editor 发布,这是一款基于 CodeMirror 6 的实时预览 Markdown 编辑器,直接编辑 Markdown 源码而非文档树,保存的文件即所写内容。它支持无损往返,未编辑保存时文件字节级不变;标题、表格、数学公式、Mermaid 图等可就地渲染,表格单元格可直接编辑。采用纯 TypeScript 与 DOM 实现,不依赖框架,可通过 npm 安装。

Hacker News 最新XUEYANZ2026/11/17 · 今天30 分钟阅读

以下正文由 AI 翻译自 Hacker News 最新(原文版权归原站所有),可能存在偏差,重要内容请以原文为准。

一个基于 CodeMirror 6 的实时预览 Markdown 编辑器,直接编辑 Markdown 源码本身,所以你保存的文件就是你写的文件。 npm install @openmarkdown-dev/editor import { createEditorState, mountEditor, openMarkdownFile, saveMarkdownFile } from "@openmarkdown-dev/editor"; const file = openMarkdownFile(new Uint8Array(await (await fetch("/notes.md")).arrayBuffer())); const editor = mountEditor(document.getElementById("editor")!, createEditorState({ doc: file.text })); const bytes = saveMarkdownFile(editor.getDoc(), file); // 未编辑:文件自身的字节 无损往返:打开一个 Markdown 文件,不做任何编辑直接保存,文件的内容和原文件逐字节完全一致。一次编辑可能改写哪些内容,列在 Fidelity 之下,fidelity 页面上还提供了一个你可以自己运行的检查。 实时预览:标题、列表、表格、数学公式、Mermaid 图表、callout 和 YAML 属性都在原地渲染;Markdown 源码显示在光标下方。 表格就地编辑:直接在绘制出来的位置编辑单元格。 图片:粘贴或拖入,拖动角来调整大小。 无框架依赖:纯 TypeScript 和 DOM。可以和 React、Vue、Svelte 一起用,也可以什么都不用。但不是免构建:如果没有打包器,请自行托管。 无需导入 CSS:所有颜色和字体都是 --ome-* 自定义属性,你可以自行覆盖。 对不可信文档安全:渲染文档时永远不会执行其中的脚本。 图表可选:@openmarkdown-dev/editor/no-diagrams 是去掉了 Mermaid 的同一编辑器,用于更小的构建体积或严格的样式策略。 SSR 安全的导入:在 Node 中导入不会触碰 window。挂载需要 DOM。 网站 · 演示 · 示例 · 文档 从 OpenMarkdown 应用中提取而来,在那里它是人们和 AI agent 每天写作所用的编辑器。MIT 许可。docs 文件夹以纯 Markdown 形式保存了各篇指南。 无损往返:打开一个 Markdown 文件,不做任何编辑直接保存,文件的内容和原文件逐字节完全一致。 这句话只是下面那条声明中的一句。对于编辑操作,该声明精确说明了会改动什么。下面是完整的声明。每一句都有测试作为支撑: OpenMarkdown 直接编辑你的 Markdown 源文本;它从不从文档树重建文件。打开并保存而不编辑,文件和原来逐字节一致:行尾符(LF / CRLF)、BOM、末尾换行、空白、制表符、转义和 Unicode 拼写都保持不变。当你编辑时,只有你触碰到的内容会改变,只有少数例外,每个例外都有测试固定:你编辑过(或点击进入过某个单元格)的表格,在离开时会整体重新对齐——对齐方式、单元格文本和转义保持不变;表格命令以同样的方式重写该表格;对列表项增加缩进或在有序列表中按 Enter,会重新编号受影响的项;在列表项中按 Enter 会去掉光标前的尾随空格;行尾符混用的文件在你编辑之后会统一为一种;在两个块之间的单独空行上输入,会在该行之后添加一个换行,从而让下面的块保持分离。 当你的宿主使用该包的 openMarkdownFile 和 saveMarkdownFile 读写文件时,该声明成立。编辑器将文档保存为使用 \n 且不带 BOM 的字符串;这两个函数保留文件的其他部分: import { createEditorState, mountEditor, openMarkdownFile, saveMarkdownFile } from "@openmarkdown-dev/editor"; let file = openMarkdownFile(bytes); // 严格 UTF-8;记录 BOM 和行尾符 const editor = mountEditor(document.getElementById("editor")!, createEditorState({ doc: file.text })); const out = saveMarkdownFile(editor.getDoc(), file); // 未编辑:原始字节 openMarkdownFile 对不是 UTF-8 的字节抛出 InvalidUtf8Error,因此损坏的文件会被拒绝,而不是被静默重写。未编辑时,saveMarkdownFile 返回原始字节,即使文件混用了行尾符也是如此。编辑后,它会写回 BOM,并对每一行使用文件的主导行尾符(出现最频繁的那个;如果并列,则取第一个)。 保存之后,把你写出的字节作为新的基线:file = openMarkdownFile(out)。然后 editor.getDoc() !== file.text 告诉你是否有未保存的编辑。 我们在六个可嵌入编辑器中(使用它们的 npm 包,在无头 Chromium 中)打开了同一个 56 行的 Markdown 文件,不做编辑直接保存,然后改动一个词再保存: Atomic Editor 在这里与我们并列,因为它的构建方式相同:源码就是文档。差异在于那些从树重建 Markdown 的编辑器。当我们编辑一个表格单元格时,两个 CodeMirror 编辑器都重新对齐了那个表格。我们的保留了列的排列。Atomic 的把分隔行重写成了 | --- |,丢失了原来的排列。 方法、示例 diff、运行日期和注意事项:我们如何比较编辑器。 npm install @openmarkdown-dev/editor @codemirror/state @codemirror/view @codemirror/commands
CodeMirror 和 Lezer 是对等依赖:你的页面必须恰好持有一份副本,之后的安装会让你安装对等依赖。temml(数学)和 mermaid(图表)是普通依赖。它们只在文档包含数学公式或图表时通过 import() 加载,你的打包器会将它们拆分成单独的 chunk。 code,减去图表支持。它导入的任何内容都不会触及 Mermaid,因此你的打包器完全不会产出 Mermaid chunk;```mermaid 块仍是一个代码块,diagrams 选项会被忽略。当没有页面需要图表时使用它,或者在 Mermaid 无法满足的样式策略下使用(见 Security)。npm 仍然会安装 mermaid,因为主入口依赖它。 import { createEditorState, mountEditor } from "@openmarkdown-dev/editor/no-diagrams"; 无打包器时 无框架依赖不等于免构建。没有自己打包器的页面可以在包发布到 CDN 后从 CDN 加载编辑器,或者构建一次然后自行提供文件:自行托管给出了构建脚本、要部署的产物以及 Content Security Policy。 import { configureEditorEnvironment, createEditorState, mountEditor } from "@openmarkdown-dev/editor"; // 可选,每页一次:语言、配色方案、剪贴板、链接、拼写。 configureEditorEnvironment({ language: "en" }); const state = createEditorState({

(原文较长,此处译出前 6000 字,完整内容请点「打开原文」。)

正文由 探How 从来源站点 RSS 同步,内容未经改写;遇到排版缺失或需要图片、视频时请以原文为准。

打开原文
去社区讨论 →