列表
无序列表
概念 -- 列表头只是一个小黑点,没有序号标注
有序列表
列表嵌套
列表可以嵌套使用,创建多层次的结构:
嵌套规则:
- 子列表需要缩进 2-4 个空格(推荐 2 个)
- 保持一致的缩进长度
- 可以无限层嵌套,但实际使用中建议不超过 3 层
任务列表(复选框列表)
任务列表是 GitHub 风格 Markdown 的扩展功能,现在被广泛支持:
基本语法:
- [ ] 未完成的任务 - [x] 已完成的任务 - [ ] 另一个未完成的任务
引用块
区块和列表
实例
代码
行内代码
如果是段落上的一个函数或片段的代码可以用反引号把它包起来()
特殊字符转义
当需要在行内代码中显示反引号或其他特殊字符时,需要进行转义处理。
显示反引号的方法:
使用双反引号包围单反引号:
代码块
缩进式代码块
三反引号代码块
注意事项:
- 缩进式代码块前后需要空行分隔
- 所有代码行必须保持一致的缩进
- 不支持语法高亮
- 在列表中使用时需要8个空格缩进
语言标识和语法高亮
在三反引号后添加语言标识符可以启用语法高亮功能。
常用语言标识符列表:
javascript
/js
- JavaScriptpython
/py
- Pythonhtml
- HTMLcss
- CSSsql
- SQLjson
- JSONxml
- XMLyaml
/yml
- YAMLbash
/shell
- Shell脚本java
- Javacpp
/c++
- C++csharp
/c#
- C#php
- PHPruby
/rb
- Rubygo
- Go语言rust
- Rusttypescript
/ts
- TypeScript
链接
链接标题的作用:
- 当鼠标悬停在链接上时显示提示信息
- 对搜索引擎优化和无障碍访问有帮助
- 标题文字放在双引号、单引号或括号中都可以
参考连接优势
- 文档正文更清爽,不被长 URL 打断
- 便于链接的统一管理和更新
- 相同链接可以重复使用,避免重复定义
- 链接定义可以放在文档任意位置(通常放在末尾)