@hia-doc/renderer-html
v0.1.4
Published
Minimal HTML renderer for HIA documents.
Readme
@hia-doc/renderer-html
HIA 文档的 HTML renderer,同时支持单一 document 与统一项目站。
The renderer consumes @hia-doc/core data and returns file payloads. It does not read from disk or own CLI behavior.
Current Scope
- 单一 document 模式输出一个
index.html。 - 统一项目站默认输出
split-site:入口页、延迟导航分片、搜索索引、关系图和逐节点 HTML fragment。 projectSite.source.presentation统一约束none、link、embed、fetch四种源码呈现方式。fetch默认在用户展开源码详情时加载;projectSite.source.fetchTrigger: "manual"可恢复显式加载按钮,且 split-site / single-page 复用同一加载逻辑。- Consumes field-level i18n text and emits runtime-switchable locale blocks.
- Marks fallback text with
data-hia-fallback-from. - Shows relative
definedInsource links, primary source blocks and referenced source fragments. - Emits default CSS/JS assets from
@hia-doc/theme-default. - 项目模式额外输出
project-index.json,作为 portal/search 可消费的稳定中立索引;源码正文不会进入该索引。 - DotNetDoc relation 可投影为 entry 的
sourceUsability:稳定 project-relative identity、resolution、confidence、provenance 与sourcesContentPolicy: none会进入 source topic 和project-index.json;renderer 不据此读取、嵌入或远程抓取源码。 - 显式
projectSite.informationArchitecture可启用[email protected]:entry|semantic-container、lazy|eager、separate|with-parent三维独立;contentPath保持 canonical,additivepresentationPath/memberAnchor驱动实际加载与定位。 - 显式 IA 使用 manifest-only
semanticPath、固定 kind-aware topic section 顺序、原生 nested disclosure 与zh-CN|entouched-label catalog;不输出role=tree,不读取 target state 或 continuity body。 - 项目输入可选接受
generatedDocumentationBindingProjection(来自@hia-doc/source-linkage):HTML 与project-index.json只读呈现 binding → expansion → target、stable instance key、resolution/confidence/provenance 与诊断计数;不加载 sidecar path、不嵌入 source body/locals,也不把完整模型放回 ordinary doc-source-map。 - 显式 Portal IA 下,项目输入可选接受
ownerAdoption(由[email protected]的portalSummary提供):只呈现 owner-review readiness、family、contract counts、可选 handoff counts 与 resolution/confidence/provenance;不接收 target/trial/owner identity、路径、正文或 adoption claim。缺少显式 IA、unknown field、count/status 不一致时 fail closed。 - 显式 IA 下可消费
[email protected]。metadata 始终采用 allowlist;只有 producer projection 与projectSite.sourceCommentProjection对同一 locale 双重授权时才显示已转义的纯文本正文。project-index.json永不包含projectedText、raw comment 或 source body。 - Returns a renderer manifest with entrypoint, locale and file metadata for CLI or other writers.
Contract
The renderer manifest schema version is exported as HIA_RENDER_HTML_MANIFEST_SCHEMA_VERSION. Project navigation index identity is exported as HIA_PROJECT_NAVIGATION_INDEX_CONTRACT and HIA_PROJECT_NAVIGATION_INDEX_CONTRACT_VERSION. Portal IA identity, exact draft version, vocabulary, types, resolver, touched-label catalog, and owner-local Draft 2020-12 schema are exported through DOCUMENTATION_PORTAL_INFORMATION_ARCHITECTURE_*. RenderProjectOwnerAdoptionSummary is a structural consumer view of the CLI-owned adoption-kit projection; the renderer does not own or reinterpret the full kit contract.
Renderer output is separate from CLI filesystem output. See docs/contract-index.md for the current layering rule.
