返回模板
Documentation layout
A responsive documentation shell with section navigation, readable prose, and code examples.
适用场景
这个结构适合需要常驻章节导航和易读技术正文的小型文档,可用于聚焦的 API 或组件指南;大型文档站还需要搜索、版本管理和更深层导航。
布局原理
导航地标链接到文章内部锚点,代码示例可以横向滚动,正文保持合适行宽,两列过窄前侧栏会移动到文章上方。
如何定制
用任务导向的快速开始、经过验证的代码、前置条件、失败情况和安全模型替换示例 API。导航名称要与标题对应,复制按钮也必须可用键盘操作。
发布前检查
验证每段代码,检查锚点跳转后的焦点,并确保标题层级合理。不要发布密钥或内部地址,要明确区分模拟行为与真实 API 支持。