Markdown Syntax Fundamentals 介绍创建结构良好文档所需的核心 Markdown 语法,并在各部分给出最佳实践。
标题:使用 # 至 ###### 表示一至六级标题。最佳实践包括:每篇文档只用单个 H1(#)作为标题;不要跳过标题级别(例如从 H2 直接跳到 H4);标题保持简洁且具描述性;句首大写或标题式大写需保持一致。
文本格式:斜体使用 italic 或 italic;粗体使用 bold 或 bold;粗斜体使用 bold italic 或 bold italic;删除线使用 strikethrough。行内代码使用反引号,例如 const x = 1。
列表:无序列表可用 -、* 或 + 作为标记,并支持嵌套。有序列表使用数字加点,支持嵌套编号。任务列表(GitHub Flavored)使用 - [x] 表示已完成、- [ ] 表示未完成。
链接:基本链接格式为 链接文字,可带标题 链接文字。引用式链接写作 [链接文字][reference-id],并在别处定义 [reference-id]: https://example.com "可选标题"。自动链接使用尖括号,如 https://example.com 或 email@example.com。内部锚点链接写作 跳转到章节,锚点 ID 由标题自动生成:转小写、空格变连字符、移除特殊字符。
图片:基本格式为 ,可带标题 。引用式图片写作 ![替代文本][image-id] 并定义 [image-id]: path/to/image.png "可选标题"。链接图片写作 。
代码块:围栏代码块使用三个反引号并标注语言,例如 ```javascript。常见语言标识符包括 javascript / js、typescript / ts、python / py、bash / shell / sh、json / yaml、html / css、sql、markdown / md。缩进代码块使用四个空格或一个制表符。
引用块:基本引用块以 > 开头,可跨多行。引用块可包含多个段落。支持嵌套引用(>>、>>>)。引用块中还可包含标题、列表和代码块等其他元素。
水平线:使用三个或更多连字符、星号或下划线,即 ---、*** 或 ___。
转义字符:使用反斜杠转义,例如 * 不斜体 *、# 不是标题、[不是链接]、`不是代码`。可转义的字符包括 \ ` * _ { } [ ] ( ) # + - . ! |。
换行:行尾两个空格可实现硬换行;空行则产生段落分隔。
最佳实践:格式保持一致,选定一种风格并坚持使用;在标题、代码块、列表和引用块的前后添加空行;考虑将行宽控制在 80 到 120 个字符以提升可读性;图片始终提供有意义的替代文本;链接文字使用描述性文字而非“点击这里”;围栏代码块始终指定语言以启用代码高亮。
该资料仅涵盖 Markdown 基础语法,未提供安装命令、收费方式、运行平台或除以上内容之外的功能说明。