xdossier

把 AI 生成的 spec 渲染成一份新人、同行、资深 reviewer 都能读的 HTML。

三档阅读模式 · 术语弹窗 · 学习检查点 · 多文档 dossier · 单文件 HTML · Apache 2.0

查看 demo ↓ GitHub npm i -g xdossier

你拿到的能力

三档阅读模式。 零基础 / 系统化 / 速查在同一份 HTML 里切换，不重渲染、不重构建。
按需展示术语弹窗、前置知识卡、学习检查点、类比说明，让同一份文档同时服务新手与专家。
教学层自动显隐。 术语弹窗、前置知识卡、学习检查点、类比说明，会按读者档位出现或收起。
多文档 dossier。 按 frontmatter 和文件名把 spec、changes、reviews 聚成一组，生成关系图和项目级索引。
单文件输出。 双击即开、可离线、无 CDN；可以发邮件、贴 PR，也可以提交进仓库。

在线 demo

这些都是真实 spec 经 xdossier 渲染后的页面。打开任意单文档 demo，可以在顶部切换 零基础 / 系统化 / 速查；打开多文档 dossier，可以看到关系图如何把相关文档串起来。

★ 新 — 多文档视图 (v0.2.0)

MVP-0 Dossier

用 xdossier 整理 xdossier 自己：MVP-0 spec、8 份实现说明、3 份 review，会按 frontmatter 和文件名前缀自动聚类，渲染成一份带内联 SVG 关系图的可导航 HTML。

打开 →

★ 主 demo — concept 模式

Pedagogy Layer Spec

xdossier 教学层自己的 spec，由 xdossier 渲染。一个页面里集中展示阅读档位、前置知识卡、学习检查点、类比说明、术语弹窗、内联 SVG 图和对照卡。

打开 →

concept 模式 · 17 个章节

Vision Spec

最初的愿景文档。包含多章节结构、风险登记、决策矩阵、结构图等语义块，也展示 ASCII 图转 SVG 架构图和章节封面。

打开 →

research / launch planning

OSS Launch Research

竞品分析、npm 名称可用性矩阵、发布传播打法和命名建议。偏速查型内容，表格密集，结论结构化。

打开 →

小提示

把同一个 demo 开在两个标签页里。一个切到 零基础，另一个切到速查。同一份 HTML，对比一下哪些内容保留，哪些内容收起。

这玩意儿为什么存在

长文档不是小问题。 你和 AI agent 会生产 800+ 行 spec。新人缺上下文，老兵只想看决策摘要，同一份文档经常同时劝退两边。
Markdown 不能自己分层。 Markdown 是线性的；HTML 可以承载折叠、弹窗、侧栏和锚点导航。xdossier 把这些空间结构用于教学和 review。
阅读档位应该是基础能力。 同一份技术文档，零基础、系统化阅读、速查三种需求都真实存在。xdossier 用单文件 HTML 在页内切换。
离线可分享。 双击 HTML 就能读，不需要网络。可以发邮件、附在 PR 里、贴进 wiki；不需要 CDN、Docker 或 SaaS。

试一下

安装 CLI，然后渲染单份 spec，或为一个目录生成多文档 dossier。

npm install -g xdossier
xdossier render docs/specs/your-spec.md   # opens spec.html with the reader toggle
xdossier cover docs/                       # builds dossier covers + project index