Skip to content
← 返回Markdown 与图表列表
Markdown与图表上手与对象

Markdown结构、链接与图表 ​

组织标题、围栏与相对链接 ​

需能阅读 Markdown 的标题、链接与代码围栏。先看本页图型示例,再对照带超时分支的完整文档检查相对链接和文字替代说明;表格、Mermaid 与显式 ID 依赖实际渲染器支持。 示例未在本轮执行。

Markdown 标题层级 ​

Markdown标题层级表达文档结构,不仅是字体大小。一个主标题下按层次组织章节,标题改名可能改变自动锚点;长期引用可用站点支持的显式ID,但CommonMark本身不规定这种扩展。

Markdown 代码围栏 ​

Markdown代码围栏使用成对反引号或波浪号。展示内层三反引号时外层用更长围栏,语言标记只影响高亮,不会执行代码;缩进和列表上下文会改变块归属。

Markdown相对链接按发布后页面路径解释,与仓库文件位置不总一致。文件移动要同时核对图片、章节锚点和站点基路径;能在编辑器点击不代表生成站点可达。

依据与适用范围 ​

以上依据用于解释本文列明的规则;示例未执行,不代表产品全部能力或跨平台验证。历史资料的版本、账号与界面位置需按目标环境确认。

选择表格、图型与文字替代说明 ​

Markdown 表格扩展 ​

Markdown表格扩展不是CommonMark核心。单元格内的竖线需按渲染器规则转义,复杂长段落更适合列表;不要为排版把结构化数据硬塞进难以窄屏阅读的宽表。

Mermaid 图表语义 ​

Mermaid图表语义先决定流程、时序还是状态。流程图表达步骤与分支,时序图表达参与者间消息,状态图表达状态转换;箭头需要标注条件,避免图形好看但缺少失败路径。

Markdown 图表替代文本 ​

Markdown图表替代文本应说明图表达的结论和必要信息。图表不能作为唯一答案,正文用文字解释关键分支;截图中的代码应同时提供可复制文本,不能只靠颜色区别状态。

排查模板、图语法与源码引用 ​

Markdown 模板转义 ​

Markdown模板转义在Vue等组件化站点尤其重要。双花括号可能被当作表达式,展示模板字面值应放代码围栏或按站点规则转义;HTML和Markdown混用时检查解析边界。

Mermaid 解析错误 ​

Mermaid解析错误先缩小到最小图,再检查引号、保留字和节点ID。显示文本与节点标识分离,版本支持不同图语法;不要把站点不支持的扩展当作所有Mermaid的错误。

Markdown 同源引用 ​

Markdown同源引用让示例源码与网页共用一个文件,避免复制后漂移。include语法属于生成器扩展,必须同时提供README和依赖声明;引用路径有效只证明文件存在,不能证明例子运行。

Mermaid 图表示例 ​

流程图 ​

流程图用于展示算法或业务流程的步骤和决策逻辑。

查看图表代码

时序图 ​

时序图用于展示对象之间的消息交互顺序。

查看图表代码

类图 ​

类图用于展示系统中的类结构及其关系。

查看图表代码

状态图 ​

状态图用于展示对象在其生命周期中的状态变化。

查看图表代码

饼图 ​

饼图用于展示各部分占总体的比例关系。

查看图表代码

继续阅读