~/field-notes — leeguoo@misonote — zsh EN ● 中文 日本語
❯ field-notes v3.4.1

← 文档库

HTML-first 文档平台样例

Phase 1 端到端样例:themed scoped 渲染、design token 级联、doc: 协议链接、资源相对路径。

2026-05-12#demo#html-first

这是什么

本文档是 HTML-first 文档平台 Phase 1 的端到端样例。它证明四件事:

  • HTML 包能被 doc-cli 校验、转换、构建到 registry。
  • themed scoped 渲染下,文档自带 <style> 不会污染主站。
  • 设计 token 通过 --platform-* 自动级联到文档。
  • doc: 协议链接被重写为站内 URL。

Token 级联演示

本节所有颜色、边框、字体都来自 --platform-*。切换主站主题 (midnight / matrix / paper),这块内容会自动跟随,无需改动文档。

样例图:token 级联示意

CSS 作用域

文档内的 article h2 选择器在 build 时会被 Transform 改写为 article[data-doc-slug="sample-html-doc"] h2, 不会影响博客其它页面的 h2

表格示例

能力 Phase 1 Phase 2
themed scoped 渲染
raw / unlisted
sandbox(iframe + bridge)
raw / private(R2 + Worker 鉴权)
全文搜索 / supersede

代码块

doc-cli validate local-html-docs/2026/sample-html-doc
doc-cli build
doc-cli publish

平台内引用其他文档使用 doc: 协议,由 Transform 改写为最终 URL: 这是一个故意指向不存在 slug 的链接, Phase 1 会在 build-report 中标记为 doc-link-broken 警告但 不阻断 publish。

⎇ main ● 0 errors · 0 warnings UTF-8 Markdown page.md © 2026 leeguoo