技术写作与文档2021github.com
Marktext——面向 Linux、macOS、Windows 的优雅 Markdown 编辑器
Marktext – Elegant Markdown Editor for Linux, macOS, Windows
导读
这是一篇介绍开源 Markdown 编辑器 Marktext 的帖子,评论围绕编辑器选型展开:所见即所得渲染、语法与拼写检查、知识库式笔记管理,以及反对 Electron 臃肿软件的吐槽。对写作者而言,它值得一读的地方在于:评论把"写作时不想被打断"和"修改时需要机器帮忙查错"这两件事拆成了具体的工具需求。
可以直接用的写作要点
- 01
优先选择能即时渲染 Markdown 的编辑器:不用在编辑区与预览窗之间来回切换,思路不容易断。
- 02
把语法检查、重复词检测、多余空格检测、正文字数统计当成修改阶段的检查清单,逐项过一遍。
- 03
用支持跨文件引用和双向链接的笔记系统积累素材,写作时更容易把旧笔记连成新文章。
- 04
别把时间花在反复换编辑器上:工具只要不挡路就够了,收敛流程比追新更重要。
HN 评论精选
所见即所得式渲染让排版不打断写作流,是选编辑器的关键标准。
据我所知,Marktext 是唯一免费开源的、带所见即所得体验的 Markdown 编辑器(类似 Typora 那种):它不是一个单独的预览窗口,而是在编辑窗口里直接把每个 Markdown 块(段落、列表项等)渲染出来,只有你正在编辑的那一块保持源码状态。
svat查看英文原文
To the best of my knowledge this (Marktext) is the only free/open-source Markdown editor that has WYSIWYG (like Typora: https://typora.io/). Not a separate preview window, but the actual editor window renders each Markdown "block" (paragraph, list item, whatever) except the one you're editing.
写作不只是打字,还需要能跨文件建立引用关系的素材与笔记系统。
我更推荐 Obsidian 这类工具:它既是 Markdown 编辑器(最近刚升级过),又带有完整的知识库与笔记系统,能跨文件建立并维护引用关系。
manigandham查看英文原文
I recommend something like Obsidian instead which is a markdown editor (newly upgraded) along with an entire knowledge base and note taking system that can create and maintain references across files. https://obsidian.md/
把拼写、重复词、空格、字数这些机械检查交给工具,作者专注表达与结构。
我希望 Markdown 编辑器能具备这些功能:语法检查;自动把句首和已知专有名词大写;悄悄修掉明显的拼写错误而不打扰我;语法层面智能的拼写检查;检测并标记误打的双空格;检测并标记重复的词;统计字数时不把标题算进去。用 Google Docs 时这些都有,我很希望在 Markdown 里也能有。
JulianMorrison查看英文原文
Things I want in a markdown editor: Grammar check. Auto-capitalise start of sentence and known proper nouns. Auto fix obvious typos without bothering me. Grammatically smart spellcheck. Detect and flag accidental double space. Detect and flag duplicate words. Word count excluding headlines. It's nice when I use Google docs and it has that stuff. I wish I had it in markdown.
同类还值得读
编写更好文档的框架
A Framework for Writing Better Documentation
这是 Divio 的文档写作框架,把技术文档按「读者的目标」分成四类:教程(学习导向)、操作指南(问题导向)、参考(信息导向)、解释(理解导向)。
技术写作与文档2021 · 637 分 · 76 评4 条写作要点编辑精选写好一份设计文档
Writing a good design document
这篇 HN 帖子标题为《Writing a good design document》,主题是如何写好一份设计文档;对写作者来说,它值得作为技术写作和结构化说明文的参照。
技术写作与文档2025 · 581 分 · 147 评3 条写作要点编辑精选技术写作课程
Technical Writing Courses
这是 Google 官方免费技术写作课程(两门),讲受众定义、主动语态、短句、文档结构等基础方法。
技术写作与文档2020 · 571 分 · 73 评4 条写作要点编辑精选写出更好的错误信息
Write better error messages
这篇帖子讨论如何写出更好的错误信息,评论补充了开发者场景下的具体做法和真实反面案例。
技术写作与文档2022 · 566 分 · 253 评4 条写作要点编辑精选写一本技术书的经济账
The Economics of Writing a Technical Book
一位技术书作者拆解写书的真实经济账:版税收入往往远低于投入的时间成本。
技术写作与文档2018 · 519 分 · 149 评4 条写作要点编辑精选