用途与理念
Markdown 是 MOOLLM 人类可读文件所用的纯文本格式。它不只是排版,更是一种理念:源文件即目标,无需渲染即可阅读,渲染后同样易读。它在任何编辑器中打开 SESSION.md 都能即时理解;在 GitHub、Obsidian、浏览器中会被增强但不会被改造;LLM 原生友好,模型在训练中接触过大量 Markdown 文件,能流利输出;对 Git 友好,差异有意义、合并可用、历史可读;无锁定,纯文本可跨平台跨年代存续。
为什么 Markdown 胜出
资料引用 Anil Dash 于 2025 年 1 月的《How Markdown Took Over the World》,列出十条技术原因并给出 MOOLLM 对应:品牌名恰好是 markup 的反义(对应 YAML Jazz、SOUL-CHAT、K-lines);解决了真实问题,HTML 对博客过于冗长(YAML 过于僵硬,注释增添灵魂);建立在既有行为上,如电子邮件格式惯例(缩进与 # 标题已直观);起源与 RSS 相呼应,创作者与博客平台推动(开源、社区驱动);社区乐于帮助,如 Dean Allen(Textile)与 Aaron Swartz(技能贡献、开放协议);针对上下文的多种风味,如 GFM、CommonMark(Adventure YAML 对会话 Markdown);行为转变的时间点,博客时代形成新习惯(LLM 时代形成新习惯);构建工具时代,Markdown 在流水线中转为 HTML(YAML 转为 JSON 再进浏览器);配合“查看源代码”,源码可检查(文件即状态,透明);无知识产权负担,免费且无专利(处处 MIT 许可)。
MOOLLM 中的使用
会话日志采用 Markdown 文档结构,包含索引、章节与可折叠详情块;README 采用技能名称、一句话精华引用、简介、使用时机、与其他技能的衔接等小节;嵌入式数据通过 Markdown 加 YAML 代码块,把结构化数据放进叙述中。
GitHub 风格 Markdown(GFM)扩展
MOOLLM 会话日志使用 GFM 扩展,包括:表格(如功能与状态对照);任务列表(如已定义模式、构建 linter、编译为 JSON);可折叠区块(details 与 summary);语法高亮(带语言提示的围栏代码块);警报(NOTE、WARNING 等 GitHub 专用语法);Mermaid 图表,GitHub 原生渲染,适合流程图、时序图、状态机、实体关系与架构图。资料给出多种 Mermaid 模式示例:流程图表示处理流,时序图表示交互,状态图表示房间状态,实体关系图表示数据模型。
LLM 与 Markdown
资料引用 Hacker News 讨论(2025 年 1 月):Markdown 本质是文本,无格式或厂商锁定,非常适合放在 Git 仓库中;可以要求 LLM 查看仓库代码并生成 API_documentation.md,模型会理解这是要一份基于文本的摘要。LLM 偏好 Markdown 的原因包括:训练数据中有数十亿 .md 文件;结构清晰,标题、列表、代码块语义明确;开销低,不像 JSON 需要括号匹配;代码块内可保留注释与上下文;人类可读,模型能自然“出声思考”。LLM 自然输出 # 标题、- 列表、加粗与表格,因此在提示词中也应使用 Markdown 写指令,以得到 Markdown 回复。
“源即目标”原则
Markdown 的力量在于它既是源文件也是可读输出。资料用表格对比:LaTeX 的 .tex 到 PDF 存在较大差距;HTML 的 .html 到浏览器存在中等差距;Markdown 的 .md 到 .md(或渲染结果)没有差距。YAML Jazz 因此重要:注释在源文件中可读、对 LLM 可见、在文件中保留。源即文档,文档即源。
MOOLLM 最佳实践
- 顶部索引:长文档需要导航,如包含章节链接的索引。
- 可折叠详情(资料强调这是关键):隐藏复杂性、展示结构,让读者扫摘要而不被细节淹没。应使用 details 与 summary 标签;summary 中应放能说明内部内容的描述性摘要,LLM 擅长生成这类摘要。
- 嵌套可折叠区块:复杂文档按层级嵌套,如部分、章节、小节。
- 结构化数据用表格:平行信息放在表格中,如房间、物件与出口。
- 示例用代码块:始终使用带语言提示的围栏代码块,如 yaml、python。
- 引用与强调用块引用。
资料还给出各模式使用时机:details open 用于主要内容与必读章节;details open(关闭态)用于支持性细节与可选深度;嵌套 details open 用于层级信息;summary 带要点让读者无需展开即可决定;summary 仅标题用于自明章节。会话日志模式中,读者看到章节标题、涵盖的关键主题,可跳过或展开完整内容,因此即便日志长达 7000 行以上仍可读。
反模式
资料列出:标题过度嵌套(超过 4 层令人困惑);处处内联 HTML(破坏纯文本可读性);无结构(没有标题与章节的文本墙);专有扩展(应坚持 GFM 以保持可移植性);只考虑渲染后效果(如果原始不可读就应重新考虑)。
持久性论点
资料引用 HN:不想担心 OneNote 所用格式到 2035 年还能否提取。2004 年的 Markdown 文件今天仍可读,2045 年仍将可读,纯文本永存。MOOLLM 的会话日志、技能文件与 README 将比任何专有格式更长久。
相关技能与协议符号
yaml-jazz/:YAML 是数据,Markdown 是叙述。session-log/:会话日志是 Markdown 文档。plain-text/:更广的哲学。soul-chat/:带嵌入式 YAML 的 Markdown。postel/:在接受 Markdown 变体时保持宽容。协议符号为 MARKDOWN,在编写文档、会话日志、README 或任何人类可读叙述时调用。
致谢与限制
资料列出致谢:John Gruber 于 2004 年创造 Markdown;Aaron Swartz 作为测试者帮助完善格式;Dean Allen 的 Textile 是先行艺术与灵感;GitHub 推动 GFM 与大规模采用;Anil Dash 撰写《How Markdown Took Over the World》(2025);CommonMark 标准化努力。资料未提供官方收费、价格、具体平台支持清单或性能数据,暂未提供相关信息。