|
|
马上注册,结交更多好友,享用更多功能,让你轻松玩转社区。
您需要 登录 才可以下载或查看,没有账号?立即注册
x
引言:Markdown的重要性与应用场景
Markdown是一种轻量级标记语言,由约翰·格鲁伯(John Gruber)于2004年创建。它允许人们使用易读易写的纯文本格式编写文档,然后转换成有效的XHTML(或者HTML)文档。Markdown的设计初衷是让文档”尽可能地可读”,并且能够直接以纯文本形式发布而看起来不像被标记过。
在当今数字化工作环境中,Markdown已成为技术写作、文档编写、内容创作的重要工具。无论是编写README文件、技术文档、博客文章,还是制作演示文稿,Markdown都能提供高效、简洁的解决方案。通过掌握Markdown,你可以:
• 提高文档编写效率
• 创建格式统一、美观的文档
• 轻松实现跨平台文档共享
• 简化版本控制和协作流程
• 专注于内容而非格式
本指南将带你从Markdown的基础语法开始,逐步深入到高级应用技巧,帮助你掌握创建专业美观高效技术文档的完整技能。
Markdown基础语法
标题与段落
标题是文档结构的基础,Markdown使用#符号来表示标题级别,支持1-6级标题:
- # 一级标题
- ## 二级标题
- ### 三级标题
- #### 四级标题
- ##### 五级标题
- ###### 六级标题
复制代码
段落是由一个或多个连续的文本行组成,段落之间用一个或多个空行分隔:
- 这是第一个段落。这里可以包含一些文本内容。
- 这是第二个段落。与上一个段落之间有一个空行分隔。
复制代码
文本格式化
Markdown提供了多种文本格式化选项:
- *斜体文本* 或 _斜体文本_
- **粗体文本** 或 __粗体文本__
- ***粗斜体文本*** 或 ___粗斜体文本___
- ~~删除线文本~~
- <u>下划线文本</u>
复制代码
效果展示:
• 斜体文本或斜体文本
• 粗体文本或粗体文本
• 粗斜体文本或粗斜体文本
• 删除线文本
• 下划线文本
列表
Markdown支持有序列表和无序列表:
无序列表使用*、+或-作为列表标记:
- * 项目一
- * 项目二
- * 子项目A
- * 子项目B
- * 项目三
- + 项目一
- + 项目二
- - 项目一
- - 项目二
复制代码
有序列表使用数字加一个点号:
- 1. 第一步
- 2. 第二步
- 3. 第三步
- 1. 子步骤A
- 2. 子步骤B
- 4. 第四步
复制代码
链接与图片
链接的基本语法如下:
- [链接文本](URL "可选的标题")
- 例如:
- [GitHub](https://github.com "访问GitHub网站")
复制代码
图片的语法与链接类似,但前面多一个感叹号:
- 
- 例如:
- 
复制代码
引用
引用使用>符号:
- > 这是一个引用段落。
- >
- > 这是同一个引用中的第二段。
- >
- > > 这是嵌套引用。
复制代码
效果:
这是一个引用段落。
这是同一个引用中的第二段。
这是嵌套引用。
代码
行内代码使用反引号(`)包围:
- 使用`print()`函数在Python中输出内容。
复制代码
代码块使用三个反引号(”`)或缩进4个空格:
- ```python
- def hello_world():
- print("Hello, World!")
-
- hello_world()
- ```
复制代码
或者:
- def hello_world():
- print("Hello, World!")
- hello_world()
复制代码
水平分割线
使用三个或更多的*、-或_创建水平分割线:
表格
Markdown支持创建简单的表格:
- | 表头1 | 表头2 | 表头3 |
- | ----- | ----- | ----- |
- | 单元格1 | 单元格2 | 单元格3 |
- | 单元格4 | 单元格5 | 单元格6 |
复制代码
效果:
可以设置对齐方式:
- | 左对齐 | 居中对齐 | 右对齐 |
- | :----- | :------: | -----: |
- | 单元格1 | 单元格2 | 单元格3 |
- | 单元格4 | 单元格5 | 单元格6 |
复制代码
效果:
Markdown进阶技巧
任务列表
任务列表是列表的扩展,用于创建待办事项:
- - [x] 已完成任务
- - [ ] 未完成任务
- - [ ] 另一个未完成任务
复制代码
效果:
• [x] 已完成任务
• [ ] 未完成任务
• [ ] 另一个未完成任务
脚注
脚注允许你在文档中添加注释和引用:
- 这是一个带有脚注的文本[^1]。
- [^1]: 这是脚注的内容。
复制代码
效果:
这是一个带有脚注的文本^1。
定义列表
定义列表用于创建术语和定义的对应关系:
- 术语1
- : 定义1
- 术语2
- : 定义2
- 可以包含多行内容
复制代码
缩写
缩写可以使用HTML的<abbr>标签:
- <abbr title="HyperText Markup Language">HTML</abbr>是网页的基础语言。
复制代码
效果:HTML是网页的基础语言。
标记
使用<mark>标签可以高亮文本:
- 使用<mark>标记</mark>可以高亮重要文本。
复制代码
效果:
使用标记可以高亮重要文本。
上标和下标
上标和下标可以使用HTML标签:
- H<sub>2</sub>O是水的化学式。
- E = mc<sup>2</sup>是爱因斯坦的质能方程。
复制代码
效果:
H2O是水的化学式。
E = mc2是爱因斯坦的质能方程。
Emoji表情
许多Markdown解析器支持Emoji表情,可以直接使用Emoji字符或简码:
- :smile: :heart: :thumbsup:
复制代码
效果:
:smile: :heart: :thumbsup:
高级应用和扩展
Markdown扩展语法
不同的Markdown解析器支持各种扩展语法,以下是一些常见的扩展:
许多Markdown解析器会自动识别URL和电子邮件地址:
- https://www.example.com
- email@example.com
复制代码
效果:https://www.example.comemail@example.com
如果不想让URL或电子邮件地址自动转换为链接,可以使用反引号:
- `https://www.example.com`
- `email@example.com`
复制代码
效果:https://www.example.comemail@example.com
一些Markdown解析器支持自动生成目录:
- [TOC]
- # 标题1
- ## 标题1.1
- ### 标题1.1.1
- ## 标题1.2
- # 标题2
复制代码
使用MathJax或KaTeX可以渲染数学公式:
- 行内公式:$E = mc^2$
- 块级公式:
- $$
- \frac{d}{dx}\left( \int_{0}^{x} f(u)\,du\right)=f(x)
- $$
复制代码
效果:
行内公式:\(E = mc^2\)
块级公式:
$\(
\frac{d}{dx}\left( \int_{0}^{x} f(u)\,du\right)=f(x)
\)$
使用Mermaid可以创建各种图表和流程图:
- ```mermaid
- graph TD;
- A[开始] --> B{条件判断};
- B -->|是| C[处理1];
- B -->|否| D[处理2];
- C --> E[结束];
- D --> E;
- ```
复制代码
效果:
- ```mermaid
- sequenceDiagram
- participant Alice
- participant Bob
- Alice->>John: Hello John, how are you?
- loop Healthcheck
- John->>John: Fight against hypochondria
- end
- Note right of John: Rational thoughts <br/>prevail!
- John-->>Alice: Great!
- John->>Bob: How about you?
- Bob-->>John: Jolly good!
- ```
复制代码
效果:
- ```mermaid
- gantt
- title 项目开发时间线
- dateFormat YYYY-MM-DD
- section 设计阶段
- 需求分析 :a1, 2023-01-01, 30d
- 原型设计 :a2, after a1, 30d
- section 开发阶段
- 前端开发 :b1, 2023-03-01, 60d
- 后端开发 :b2, 2023-03-01, 60d
- section 测试阶段
- 功能测试 :c1, after b1, 30d
- 性能测试 :c2, after b2, 20d
- ```
复制代码
效果:
自定义CSS样式
虽然Markdown本身不支持直接应用CSS样式,但许多Markdown解析器允许通过HTML标签和内联样式来自定义外观:
- <div style="background-color: #f8f9fa; padding: 15px; border-radius: 5px; border-left: 4px solid #007bff;">
- <p style="margin: 0; color: #495057;">这是一个带有自定义样式的信息框。</p>
- </div>
复制代码
效果:这是一个带有自定义样式的信息框。
这是一个带有自定义样式的信息框。
嵌入HTML内容
Markdown允许直接嵌入HTML标签,这大大扩展了其功能:
- <details>
- <summary>点击展开/折叠</summary>
- <p>这是隐藏的内容,点击上面的标题可以展开或折叠。</p>
- </details>
- <kbd>Ctrl</kbd> + <kbd>C</kbd> 用于复制选中的内容。
复制代码
效果:点击展开/折叠这是隐藏的内容,点击上面的标题可以展开或折叠。
这是隐藏的内容,点击上面的标题可以展开或折叠。
Ctrl+C用于复制选中的内容。
使用变量和模板
一些高级Markdown工具支持变量和模板功能,可以创建可重用的文档组件:
- {{% notice info %}}
- 这是一个信息提示框,使用模板变量创建。
- {{% /notice %}}
- {{< figure src="/images/logo.png" alt="Logo" caption="公司Logo" >}}
复制代码
专业文档写作最佳实践
结构化文档设计
创建专业文档的第一步是设计良好的文档结构:
1. 明确文档目的和受众:确定文档的主要目标和目标读者
2. 创建大纲:使用标题层级组织内容,确保逻辑清晰
3. 保持一致性:在整个文档中使用一致的格式和术语
4. 添加导航元素:如目录、页内链接等,方便读者浏览
示例文档结构:
- # 文档标题
- ## 简介
- - 文档目的
- - 目标受众
- - 如何使用本文档
- ## 目录
- [TOC]
- ## 基础概念
- ### 概念1
- ### 概念2
- ## 操作指南
- ### 步骤1
- ### 步骤2
- ### 步骤3
- ## 常见问题
- ### 问题1
- ### 问题2
- ## 参考资料
- - 链接1
- - 链接2
复制代码
内容组织技巧
有效的内容组织可以大大提高文档的可读性和实用性:
1. 使用F模式布局:将最重要的信息放在左上角,次要信息向右下延伸
2. 信息分层:使用标题、列表和段落创建清晰的信息层次
3. 分块处理:将相关内容组织成逻辑块,使用标题和分隔线区分
4. 添加交叉引用:使用链接连接相关内容,方便读者跳转
示例:
- # 产品使用指南
- ## 快速入门
- 新用户?从这里开始,了解产品的基本功能和使用方法。
- ### 第一步:注册账户
- [注册账户详细说明](#注册账户)
- ### 第二步:配置设置
- [配置设置详细说明](#配置设置)
- ### 第三步:开始使用
- [开始使用详细说明](#开始使用)
- ## 详细功能说明
- ### 注册账户 {#注册账户}
- 1. 访问我们的网站
- 2. 点击"注册"按钮
- 3. 填写必要信息
- 4. 验证电子邮件
- ### 配置设置 {#配置设置}
- ...
- ### 开始使用 {#开始使用}
- ...
复制代码
可读性优化
提高文档可读性的技巧:
1. 使用简洁明了的语言:避免冗长复杂的句子
2. 控制段落长度:每个段落聚焦一个主题,长度适中
3. 添加视觉元素:使用图片、图表、代码示例等增强理解
4. 强调关键信息:使用粗体、斜体、高亮等突出重要内容
示例:
- # 数据备份指南
- ## 概述
- **定期备份数据是保护信息安全的必要措施**。本指南将指导您如何正确备份和恢复数据。
- ## 备份步骤
- ### 1. 选择备份类型
- 我们提供三种备份选项:
- - **完整备份**:备份所有数据(推荐首次使用)
- - *增量备份*:仅备份自上次备份以来的更改
- - ~差异备份~:备份自上次完整备份以来的所有更改
- ### 2. 设置备份计划
- <mark>建议设置自动备份计划</mark>,确保数据定期更新:
- | 备份类型 | 频率 | 保留时间 |
- | -------- | ---- | -------- |
- | 完整备份 | 每周 | 4周 |
- | 增量备份 | 每日 | 2周 |
- ### 3. 执行备份
- 点击"立即备份"按钮开始备份过程。备份时间取决于数据量:
- ```python
- # 示例:检查备份状态
- def check_backup_status():
- status = get_current_status()
- if status == "completed":
- print("备份已完成!")
- elif status == "in_progress":
- print("备份进行中,请稍候...")
- else:
- print("备份尚未开始。")
复制代码
提示:首次完整备份可能需要较长时间,建议在网络空闲时段进行。
- ### 版本控制与协作
- 在团队环境中使用Markdown文档时,版本控制和协作非常重要:
- 1. **使用Git进行版本控制**:跟踪文档变更,便于回滚和比较
- 2. **建立分支策略**:如功能分支、发布分支等,规范协作流程
- 3. **编写清晰的提交信息**:说明每次变更的目的和内容
- 4. **使用Pull Request进行审查**:确保文档质量和一致性
- 示例Git工作流程:
- ```markdown
- # 文档协作指南
- ## Git工作流程
- ### 1. 创建功能分支
- ```bash
- # 创建新分支
- git checkout -b docs/update-api-guide main
复制代码
2. 进行更改并提交
- # 添加更改
- git add docs/api-guide.md
- # 提交更改
- git commit -m "docs: 更新API指南,添加新端点说明"
复制代码
3. 推送分支并创建PR
- # 推送分支
- git push origin docs/update-api-guide
复制代码
然后在GitHub/GitLab上创建Pull Request,请求团队成员审查。
4. 解决反馈并合并
根据团队成员的反馈进行修改,确认无误后合并到主分支。
提交信息规范
我们使用Conventional Commits规范:
- <类型>[可选的作用域]: <描述>
- [可选的正文]
- [可选的脚注]
复制代码
类型包括:
• docs: 文档更改
• feat: 新功能
• fix: 错误修复
• refactor: 重构
• style: 格式(不影响代码运行的变动)
• test: 增加测试
• chore: 构建过程或辅助工具的变动
示例:
- docs(api): 添加用户认证端点说明
- 更新API文档,添加用户认证相关的端点说明和示例代码。
- Closes #123
复制代码- ### 文档维护与更新
- 保持文档的时效性和准确性是一项持续工作:
- 1. **建立审查周期**:定期检查和更新文档内容
- 2. **收集用户反馈**:通过评论、问题跟踪等方式收集改进建议
- 3. **标记过时内容**:使用标签或注释标识需要更新的部分
- 4. **自动化检查**:使用工具检测链接有效性、代码示例正确性等
- 示例文档维护策略:
- ```markdown
- # 文档维护计划
- ## 定期审查
- - **月度审查**:检查所有文档的准确性和时效性
- - **季度更新**:根据产品更新和用户反馈进行全面更新
- ## 过时内容标记
- 使用以下标签标记需要关注的内容:
- ```markdown
- <!-- @todo 需要更新以反映最新API变更 -->
- 这部分内容可能已过时,请参考最新文档。
- <!-- @deprecated 此功能将在下一版本中移除 -->
- 注意:此功能已被弃用,建议使用替代方案。
复制代码
自动化检查
我们使用以下工具自动检查文档质量:
• Markdownlint:检查Markdown语法和风格
• lychee:检查链接有效性
• markdown-link-check:GitHub Action用于链接检查
用户反馈收集
我们通过以下渠道收集用户反馈:
• GitHub Issues
• 文档评论系统
• 用户调查问卷
• 支持工单分析
- ## 工具和资源推荐
- ### Markdown编辑器
- 选择合适的Markdown编辑器可以大大提高写作效率:
- #### Visual Studio Code
- VS Code是一款免费、开源的代码编辑器,通过插件可以成为强大的Markdown编辑器:
- ```markdown
- 推荐插件:
- - Markdown All in One:提供全面的Markdown编辑支持
- - Markdown Preview Enhanced:增强的预览功能
- - MarkdownLint:检查和修复Markdown语法问题
- - Paste Image:直接粘贴图片到Markdown文档
- - Markdown Shortcuts:提供快捷键和工具栏
复制代码
Typora是一款所见即所得的Markdown编辑器,提供流畅的写作体验:
- 主要特点:
- - 实时预览
- - 无干扰模式
- - 图表支持
- - 数学公式
- - 代码高亮
- - 文件导出功能
复制代码
Mark Text是一款开源的实时预览Markdown编辑器:
- 主要特点:
- - 实时预览
- - 支持CommonMark规范
- - 支持GitHub Flavored Markdown
- - 主题自定义
- - 导出为PDF、HTML等格式
复制代码
在线Markdown工具
GitHub和GitLab提供了内置的Markdown支持和预览功能:
- 使用场景:
- - README文件编写
- - Wiki文档创建
- - Issue和PR描述
- - 代码注释
复制代码
Notion是一款集笔记、知识库、任务管理于一体的工具,支持Markdown:
- 主要特点:
- - 块编辑器
- - 数据库功能
- - 协作功能
- - 模板系统
- - 多平台支持
复制代码
StackEdit是一款在线Markdown编辑器,支持与云存储服务同步:
- 主要特点:
- - 在线编辑和预览
- - 支持多种云存储服务
- - 实时协作
- - 数学公式支持
- - 导出功能
复制代码
Markdown转换工具
Pandoc是一款强大的文档转换工具,支持Markdown与其他格式之间的转换:
- # Markdown转HTML
- pandoc -f markdown -t html input.md -o output.html
- # Markdown转PDF
- pandoc -f markdown -t pdf input.md -o output.pdf
- # Markdown转Word
- pandoc -f markdown -t docx input.md -o output.docx
- # 批量转换
- for file in *.md; do
- pandoc "$file" -o "${file%.md}.html"
- done
复制代码
MkDocs是一个静态站点生成器,专为Markdown文档设计:
- # 安装MkDocs
- pip install mkdocs
- # 创建新项目
- mkdocs new my-project
- # 构建站点
- mkdocs build
- # 启动开发服务器
- mkdocs serve
- # 部署到GitHub Pages
- mkdocs gh-deploy
复制代码
Sphinx是Python文档生成工具,支持reStructuredText和Markdown:
- # 安装Sphinx和Markdown支持
- pip install sphinx recommonmark
- # 创建新项目
- sphinx-quickstart
- # 构建HTML文档
- make html
- # 构建PDF文档
- make latexpdf
复制代码
Markdown验证和检查工具
Markdownlint是一个用于检查和修复Markdown文件的工具:
- # 安装
- npm install -g markdownlint-cli
- # 检查文件
- markdownlint myfile.md
- # 检查目录
- markdownlint docs/
- # 使用自定义配置
- markdownlint -c .markdownlint.json docs/
复制代码
示例.markdownlint.json配置:
- {
- "default": true,
- "MD013": {
- "line_length": 100
- },
- "MD033": false,
- "MD036": false
- }
复制代码
用于检查Markdown文件中的链接是否有效:
- # 安装
- npm install -g markdown-link-check
- # 检查文件
- markdown-link-check myfile.md
- # 检查目录
- find . -name "*.md" -exec markdown-link-check {} \;
复制代码
Vale是一个可定制的语法、风格和单词检查器:
- # 安装
- brew install vale
- # 初始化
- vale init
- # 检查文件
- vale myfile.md
- # 检查目录
- vale docs/
复制代码
示例.vale.ini配置:
- StylesPath = styles
- MinAlertLevel = suggestion
- [*]
- BasedOnStyles = Vale
- [*.md]
- BasedOnStyles = Vale, Microsoft
复制代码
模板和资源库
- # 项目README模板
- ```markdown
- # 项目名称
- [](LICENSE)
- [](https://travis-ci.org/username/project)
- [](https://coveralls.io/github/username/project?branch=main)
- ## 简介
- 简要描述项目的目的和功能。
- ## 安装
- ```bash
- # 使用npm安装
- npm install project-name
- # 使用yarn安装
- yarn add project-name
复制代码
使用
- const project = require('project-name');
- // 示例代码
- project.doSomething();
复制代码
API文档
方法1
描述方法1的用途和参数。
参数
• param1(Type): 参数1的描述
• param2(Type): 参数2的描述
返回值(Type): 返回值的描述
示例
- const result = project.method1(param1, param2);
- console.log(result);
复制代码
贡献
欢迎贡献!请阅读贡献指南了解详情。
许可证
MIT©用户名
- #### 技术文档模板
- ```markdown
- # 技术文档标题
- ## 概述
- 描述技术文档的范围、目的和目标受众。
- ## 先决条件
- 列出阅读本文档前需要了解的知识或技能。
- ## 基本概念
- 解释相关的基本概念和术语。
- ## 操作指南
- ### 任务1
- 描述任务1的目的。
- #### 步骤1:准备工作
- 详细说明步骤1的操作。
- #### 步骤2:执行操作
- 详细说明步骤2的操作。
- ```bash
- # 示例命令
- command --option value
复制代码
详细说明如何验证操作是否成功。
任务2
…
故障排除
问题1:描述问题
原因:解释问题的可能原因。
解决方案:提供解决问题的步骤。
问题2:描述问题
…
API参考
端点1:/api/endpoint1
描述:端点1的用途和功能。
方法:GET
参数:
• param1(Type, 必需):参数1的描述
• param2(Type, 可选):参数2的描述
响应:
- {
- "status": "success",
- "data": {
- "field1": "value1",
- "field2": "value2"
- }
- }
复制代码
示例:
- curl -X GET "https://api.example.com/api/endpoint1?param1=value1"
复制代码
端点2:/api/endpoint2
…
参考资料
• 资源1
• 资源2
• 资源3
- #### 会议记录模板
- ```markdown
- # 会议记录 - [会议名称]
- **日期**:YYYY-MM-DD
- **时间**:HH:MM - HH:MM
- **地点**:会议室/线上会议链接
- **主持人**:[姓名]
- **记录人**:[姓名]
- **参会人员**:[姓名1], [姓名2], [姓名3]
- ## 议程
- 1. 议题1
- 2. 议题2
- 3. 议题3
- ## 讨论内容
- ### 议题1:[议题标题]
- **背景**:简要介绍议题背景。
- **讨论要点**:
- - 要点1
- - 要点2
- - 要点3
- **决定**:
- - 决定1
- - 决定2
- ### 议题2:[议题标题]
- ...
- ## 行动项目
- | 任务 | 负责人 | 截止日期 | 状态 |
- | ---- | ------ | -------- | ---- |
- | [任务描述] | [姓名] | YYYY-MM-DD | [未开始/进行中/已完成] |
- | [任务描述] | [姓名] | YYYY-MM-DD | [未开始/进行中/已完成] |
- ## 下次会议
- **日期**:YYYY-MM-DD
- **时间**:HH:MM - HH:MM
- **地点**:待定
- **议程**:
- 1. 回顾本次会议行动项目
- 2. 新议题1
- 3. 新议题2
- ## 附件
- - [附件1](链接)
- - [附件2](链接)
复制代码
总结:Markdown文档写作的未来发展
Markdown作为一种轻量级标记语言,凭借其简洁、易读、易写的特点,已经成为技术文档写作的重要工具。通过本指南的学习,你已经掌握了从基础语法到高级应用的Markdown写作技巧,能够创建专业、美观、高效的技术文档。
Markdown的优势回顾
1. 简洁高效:Markdown语法简单直观,可以专注于内容而非格式
2. 平台无关:纯文本格式可在任何平台编辑和查看
3. 易于转换:可轻松转换为HTML、PDF、Word等多种格式
4. 版本控制友好:纯文本格式适合Git等版本控制系统
5. 扩展性强:通过各种扩展和工具,可实现复杂功能
未来发展趋势
Markdown和文档写作领域正在不断发展,以下是一些值得关注的趋势:
1. 智能化写作辅助:AI辅助写作工具将提供更智能的内容建议、自动摘要和翻译功能
2. 交互式文档:Markdown将支持更多交互元素,如可执行代码示例、交互式图表等
3. 多模态内容:集成文本、图像、音频、视频等多种媒体形式的文档将更加普遍
4. 协作功能增强:实时协作、评论、版本比较等功能将更加完善
5. 语义化增强:Markdown将更好地支持语义标记,提高文档的可访问性和SEO友好性
持续学习的建议
为了保持Markdown写作技能的竞争力,建议:
1. 关注社区动态:参与Markdown社区,了解最新发展和最佳实践
2. 尝试新工具:定期尝试新的Markdown编辑器和工具,找到最适合自己工作流程的解决方案
3. 分享经验:通过博客、演讲或开源项目分享你的Markdown写作经验
4. 收集反馈:从读者和同事那里收集反馈,不断改进你的文档写作技巧
5. 探索相关领域:了解信息架构、用户体验设计、技术传播等相关领域的知识
结语
Markdown不仅是一种标记语言,更是一种思维方式和工作方法。通过掌握Markdown写作技巧,你可以更高效地创建和维护技术文档,提高团队协作效率,并最终为用户提供更好的文档体验。
希望本指南能够帮助你在Markdown文档写作的道路上取得成功。无论你是技术写作者、开发人员、项目经理还是学生,Markdown都将成为你日常工作中不可或缺的工具。继续探索、学习和实践,你会发现Markdown的无限可能性。
附录:快速参考卡片
- # 标题
- ## 二级标题
- ### 三级标题
- *斜体* 或 _斜体_
- **粗体** 或 __粗体__
- ~~删除线~~
- - 无序列表项
- 1. 有序列表项
- [链接](https://example.com)
- 
- > 引用文本
- `行内代码`
复制代码
代码块
- | 表头 | 表头 |
- | ---- | ---- |
- | 单元格 | 单元格 |
- ---
- 水平分割线
- - [x] 已完成任务
- - [ ] 未完成任务
- 脚注[^1]
- [^1]: 脚注内容
复制代码
祝你写作愉快! |
|