md-validation

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

md-validation

md-validation

Mermaid Diagrams

Mermaid图表

Validate Mermaid diagrams render correctly before shipping. Open the HTML artifact in a browser and check every diagram visually — syntax errors show as broken renders, not error messages.
Common failure modes:
  • Unquoted labels with punctuation break the parse
  • Bare lowercase
    end
    collides with subgraph terminator
  • Node IDs starting with
    o
    or
    x
    after edge markers get misparsed
  • Custom fills without matching text color make labels unreadable
See
resources/mermaid-authoring.md
for the full authoring rules (quoting, line breaks, reserved words, themes).
在发布前验证Mermaid图表能否正确渲染。在浏览器中打开HTML制品,直观检查每个图表——语法错误会显示为损坏的渲染效果,而非错误提示。
常见失败模式:
  • 带有标点的未加引号标签会破坏解析
  • 小写的裸
    end
    会与子图终止符冲突
  • 边标记后以
    o
    x
    开头的节点ID会被错误解析
  • 没有匹配文本颜色的自定义填充会导致标签无法读取
完整的创作规则(引号使用、换行、保留字、主题)请查看
resources/mermaid-authoring.md

Markdown Links

Markdown链接

Check that relative links between pages resolve. When building a multi-page artifact or KB, broken cross-references silently rot — verify each link target exists before committing.
检查页面间的相对链接是否可解析。在构建多页制品或知识库时,损坏的交叉引用会悄然失效——提交前请验证每个链接目标是否存在。