活动公告

系统通知
通知：本站资源由网友上传分享，如有违规等问题请到版务模块进行投诉，资源失效请在帖子内回复要求补档，会尽快处理！
10-23 09:31
>社区 > 科技 > 经验交流 >帖子
本版发帖返回

Markdown语法规则完全指南轻松掌握文档格式化技巧提升写作效率从入门到精通

这是个蓝孩子 当前离线 威震华夏关云长
SunJu_FaceMall

3万

主题

2697

科技点

3万

积分

执行版主

碾压王

积分
32881

塔罗立华奏
执行版主 发表于 2025-8-31 00:40:39 | 显示全部楼层 |阅读模式

马上注册，结交更多好友，享用更多功能，让你轻松玩转社区。

您需要 登录 才可以下载或查看，没有账号？立即注册

x
引言

Markdown是一种轻量级标记语言，由约翰·格鲁伯（John Gruber）于2004年创建。它允许人们使用易读易写的纯文本格式编写文档，然后转换成有效的HTML或其他格式。Markdown的设计目标是让文档”尽可能易读易写”，并且可以轻松转换为结构化的HTML。

Markdown的优势在于其简洁性和可移植性。与复杂的文字处理软件不同，Markdown文件是纯文本格式，可以在任何设备上打开和编辑，不会出现格式混乱的问题。同时，Markdown语法简单直观，学习成本低，即使是非技术人员也能快速上手。

Markdown广泛应用于技术文档、博客文章、GitHub README文件、学术论文、笔记系统等领域。掌握Markdown不仅能提高写作效率，还能让你的文档更加专业和规范。

本指南将从基础语法开始，逐步深入到高级技巧，帮助你全面掌握Markdown，提升文档格式化能力。

Markdown基础语法

标题

标题是文档结构的基础，Markdown提供了六级标题，对应HTML中的<h1>到<h6>标签。

使用方法：在文本前加上1-6个#符号，#的数量代表标题的级别。
  2. # 一级标题
  3. ## 二级标题
  4. ### 三级标题
  5. #### 四级标题
  6. ##### 五级标题
  7. ###### 六级标题
复制代码

渲染效果：

二级标题

三级标题

另外，Markdown还支持Setext风格的一级和二级标题，分别使用=和-作为下划线：
  2. 一级标题
  3. =========
  5. 二级标题
  6. ---------
复制代码

段落和换行

在Markdown中，段落由一个或多个连续的文本行组成，段落之间由一个或多个空行分隔。
  2. 这是第一个段落。这里有一些文本内容。
  4. 这是第二个段落。它与第一个段落之间有一个空行。
复制代码

要在段落内创建换行，可以在行末添加两个或更多空格，然后按回车键：
  2. 这是第一行，行末有两个空格。  
  3. 这是第二行，紧接在第一行之后。
复制代码

或者使用HTML的<br>标签：
  2. 这是第一行。<br>这是第二行。
复制代码

强调（粗体、斜体）

Markdown使用星号(*)和下划线(_)来表示强调。

斜体：用一个*或_包围文本
  2. *这是斜体文本*
  3. _这也是斜体文本_
复制代码

粗体：用两个*或_包围文本
  2. **这是粗体文本**
  3. __这也是粗体文本__
复制代码

粗斜体：用三个*或_包围文本
  2. ***这是粗斜体文本***
  3. ___这也是粗斜体文本___
复制代码

列表（有序、无序）

Markdown支持有序列表和无序列表。

无序列表：使用*、+或-作为列表标记
  2. * 项目一
  3. * 项目二
  4.   * 子项目 A
  5.   * 子项目 B
  6. * 项目三
  8. + 项目一
  9. + 项目二
  10.   + 子项目 A
  11.   + 子项目 B
  12. + 项目三
  14. - 项目一
  15. - 项目二
  16.   - 子项目 A
  17.   - 子项目 B
  18. - 项目三
复制代码

有序列表：使用数字加一个点作为列表标记
  2. 1. 第一步
  3. 2. 第二步
  4.    1. 子步骤 A
  5.    2. 子步骤 B
  6. 3. 第三步
复制代码

注意：有序列表的数字本身并不影响最终的HTML输出，Markdown会自动为你编号。所以下面的写法会产生相同的输出：
  2. 1. 项目一
  3. 1. 项目二
  4. 1. 项目三
复制代码

引用

引用使用>符号表示，可以嵌套引用。
  2. > 这是一个引用。
  3. >
  4. > 这是引用的第二段。
  5. >
  6. > > 这是嵌套引用。
  7. > >
  8. > > 嵌套引用可以继续。
复制代码

代码

要在行内插入代码，使用反引号(`)包围代码：
  2. 使用`printf()`函数在C语言中输出文本。
复制代码

对于代码块，可以使用缩进或围栏代码块。

缩进代码块：将代码块缩进4个空格或1个制表符：
  2. <html>
  3.       <head>
  4.         <title>页面标题</title>
  5.       </head>
  6.       <body>
  7.         <p>这是一个段落。</p>
  8.       </body>
  9.     </html>
复制代码

围栏代码块：使用三个或更多反引号或波浪线包围代码块，并可以指定语言以实现语法高亮：
  2. ```javascript
  3. function greeting(name) {
  4.   console.log(`Hello, ${name}!`);
  5. }
  7. greeting('World');
复制代码
  2. ### 水平分割线
  4. 水平分割线可以使用三个或更多的`*`、`-`或`_`创建：
  6. ```markdown
  7. ***
  9. ---
  11. ___
复制代码

Markdown进阶语法

链接

Markdown支持两种链接形式：行内链接和参考式链接。

行内链接：
  2. [链接文本](URL "可选的标题")
  4. [Google](https://www.google.com)
  5. [GitHub](https://github.com "访问GitHub")
复制代码

参考式链接：
  2. [链接文本][参考标识]
  4. [Google][1]
  5. [GitHub][2]
  7. [1]: https://www.google.com "访问Google"
  8. [2]: https://github.com "访问GitHub"
复制代码

也可以使用简化的参考式链接：
  2. [Google][]
  3. [GitHub][]
  5. [Google]: https://www.google.com "访问Google"
  6. [GitHub]: https://github.com "访问GitHub"
复制代码

图片

图片的语法与链接类似，只是在前面加一个感叹号(!)。
  2. ![替代文本](图片URL "可选的标题")
  4. ![Markdown Logo](https://markdown-here.com/img/icon256.png "Markdown图标")
复制代码

同样支持参考式图片：
  2. ![替代文本][参考标识]
  4. ![Markdown Logo][logo]
  6. [logo]: https://markdown-here.com/img/icon256.png "Markdown图标"
复制代码

表格

表格使用竖线(|)分隔单元格，使用连字符(-)创建表头行分隔线。
  2. | 对齐方式 | 语法 | 示例 |
  3. |:--------|:----:|-----:|
  4. | 左对齐   | :--- | 文本 |
  5. | 居中     | :--: | 文本 |
  6. | 右对齐   | ---: | 文本 |
复制代码

渲染效果：

任务列表

任务列表是列表的扩展，用于创建待办事项列表。
  2. - [x] 已完成的任务
  3. - [ ] 未完成的任务
  4. - [ ] 另一个未完成的任务
  5.   - [x] 已完成的子任务
  6.   - [ ] 未完成的子任务
复制代码

代码块与语法高亮

如前所述，围栏代码块可以指定语言以实现语法高亮：
  2. ```python
  3. def fibonacci(n):
  4.     if n <= 0:
  5.         return []
  6.     elif n == 1:
  7.         return [0]
  8.     elif n == 2:
  9.         return [0, 1]
  10.     else:
  11.         fib = [0, 1]
  12.         for i in range(2, n):
  13.             fib.append(fib[i-1] + fib[i-2])
  14.         return fib
  16. print(fibonacci(10))
复制代码
  2. 不同的Markdown解析器支持的语言可能不同，常见的语言标识包括：javascript, python, java, c, cpp, html, css, json, sql, bash, shell等。
  4. ## Markdown扩展语法
  6. ### 注脚
  8. 注脚允许你在文档中添加注释和引用。
  10. ```markdown
  11. 这是一个带有注脚的文本[^1]。
  13. [^1]: 这是注脚的内容。
复制代码

定义列表

定义列表用于创建术语和定义的对应关系。
  2. 术语 1
  3. :   定义 1
  5. 术语 2
  6. :   定义 2a
  7. :   定义 2b
复制代码

缩写

缩写使用HTML的<abbr>标签。
  2. HTML 是超文本标记语言的缩写。
  4. *[HTML]: Hyper Text Markup Language
复制代码

标记

标记（高亮）使用两个等号(==)包围文本。
  2. ==这是被标记的文本==
复制代码

注意：这不是所有Markdown解析器都支持的功能。

自定义属性

一些Markdown解析器支持使用花括号添加自定义属性。
  2. 这是一个带ID的段落 {#paragraph-id}
  4. [链接](url){:target="_blank"}
复制代码

Markdown工具与平台

编辑器推荐

1. Visual Studio Code：免费开源的代码编辑器，通过插件支持Markdown预览和编辑。
2. Typora：所见即所得的Markdown编辑器，界面简洁，功能强大。
3. Mark Text：实时预览的Markdown编辑器，支持各种主题和导出格式。
4. Obsidian：基于Markdown的知识管理和笔记工具，支持双向链接。
5. Notion：集成笔记、知识库和任务管理的多功能工具，支持Markdown语法。

在线平台

1. GitHub：广泛使用Markdown格式化README文件、Wiki和Issue。
2. GitLab：类似GitHub，支持Markdown格式的文档。
3. StackEdit：在线Markdown编辑器，支持同步到Google Drive和Dropbox。
4. Dillinger：功能丰富的在线Markdown编辑器。
5. Jupyter Notebook：支持Markdown单元格的数据科学工具。

转换工具

1. Pandoc：万能文档转换器，支持Markdown与多种格式之间的转换。
2. Markdown Here：浏览器扩展，将Markdown转换为HTML并显示在网页上。
3. Marp：将Markdown转换为演示文稿的工具。
4. Hugo/Jekyll：静态网站生成器，使用Markdown作为内容源。

实用技巧与最佳实践

快捷键使用

掌握常用Markdown编辑器的快捷键可以显著提高写作效率。以下是一些常见快捷键：

• 粗体：Ctrl/Cmd + B
• 斜体：Ctrl/Cmd + I
• 标题：Ctrl/Cmd + 1-6（对应1-6级标题）
• 无序列表：Ctrl/Cmd + Shift + U
• 有序列表：Ctrl/Cmd + Shift + O
• 链接：Ctrl/Cmd + K
• 图片：Ctrl/Cmd + Shift + I
• 代码块：Ctrl/Cmd + Alt + C
• 引用：Ctrl/Cmd + Shift + Q

模板创建

为常用文档类型创建模板可以节省时间并保持一致性。例如：

README模板：
  2. # 项目名称
  4. 简短的项目描述。
  6. ## 功能特性
  8. - 特性 1
  9. - 特性 2
  10. - 特性 3
  12. ## 安装指南
  14. ```bash
  15. # 安装命令
  16. npm install package-name
复制代码

使用方法
  2. // 使用示例
  3. const package = require('package-name');
  4. package.doSomething();
复制代码

API文档

方法名

methodName(param1, param2)

描述方法的功能。

参数：

• param1(类型)：参数1的描述
• param2(类型)：参数2的描述

返回值：(类型) 返回值的描述

贡献指南

1. Fork 本仓库
2. 创建你的特性分支 (git checkout -b feature/AmazingFeature)
3. 提交你的更改 (git commit -m 'Add some AmazingFeature')
4. 推送到分支 (git push origin feature/AmazingFeature)
5. 打开一个 Pull Request

许可证

本项目采用MIT许可证。
  2. ### 与其他格式转换
  4. 使用Pandoc等工具，可以轻松地将Markdown转换为其他格式：
  6. ```bash
  7. # Markdown转HTML
  8. pandoc -f markdown -t html input.md -o output.html
  10. # Markdown转PDF
  11. pandoc -f markdown -t latex input.md -o output.pdf
  13. # Markdown转Word
  14. pandoc -f markdown -t docx input.md -o output.docx
复制代码

版本控制与Markdown

Markdown的纯文本特性使其非常适合与版本控制系统（如Git）一起使用：

1. 变更追踪：可以清晰地看到文档的每次修改。
2. 协作编辑：多人可以同时编辑，并通过合并请求整合更改。
3. 分支管理：可以为不同版本的文档创建分支。
4. 历史记录：可以查看和恢复文档的任何历史版本。

常见问题与解决方案

问题1：表格对齐不正确

解决方案：确保表头行下的分隔线使用正确的冒号位置来指定对齐方式：
  2. | 左对齐 | 居中 | 右对齐 |
  3. |:-------|:----:|------:|
  4. | 文本   | 文本 | 文本  |
复制代码

问题2：代码块中的特殊字符被解析

解决方案：使用围栏代码块并指定语言，或对特殊字符进行HTML转义：
  2. ```html
  3. <div class="example">
  4.   <p>这是一个段落。</p>
  5. </div>
复制代码
  2. ### 问题3：列表嵌套不正确
  4. **解决方案**：确保子列表前有适当的缩进（通常为2-4个空格）：
  6. ```markdown
  7. - 项目一
  8.   - 子项目 A
  9.   - 子项目 B
  10. - 项目二
复制代码

问题4：链接在新标签页打开

解决方案：使用HTML语法并添加target="_blank"属性：
  2. <a href="https://example.com" target="_blank">链接文本</a>
复制代码

问题5：Markdown表格内换行

解决方案：使用HTML的<br>标签：
  2. | 列1 | 列2 |
  3. |-----|-----|
  4. | 第一行<br>第二行 | 文本 |
复制代码

总结与进阶学习资源

Markdown是一种简单而强大的文档格式化工具，通过本指南，你已经从基础语法到高级技巧全面了解了Markdown。掌握Markdown不仅能提高你的写作效率，还能让你的文档更加专业和规范。

要进一步提升你的Markdown技能，可以参考以下资源：

1. 官方资源：John Gruber的Markdown官方文档CommonMark规范GitHub Flavored Markdown规范
2. John Gruber的Markdown官方文档
3. CommonMark规范
4. GitHub Flavored Markdown规范
5. 教程与指南：Markdown教程Markdown指南Mastering Markdown by GitHub
6. Markdown教程
7. Markdown指南
8. Mastering Markdown by GitHub
9. 工具与资源：Awesome Markdown：Markdown工具和资源集合Markdown Here：浏览器扩展，将Markdown转换为HTMLPandoc：万能文档转换器
10. Awesome Markdown：Markdown工具和资源集合
11. Markdown Here：浏览器扩展，将Markdown转换为HTML
12. Pandoc：万能文档转换器
13. 社区与论坛：Stack Overflow：Markdown相关问题Reddit r/Markdown：Markdown社区讨论GitHub Community：GitHub上的Markdown讨论
14. Stack Overflow：Markdown相关问题
15. Reddit r/Markdown：Markdown社区讨论
16. GitHub Community：GitHub上的Markdown讨论

官方资源：

• John Gruber的Markdown官方文档
• CommonMark规范
• GitHub Flavored Markdown规范

教程与指南：

• Markdown教程
• Markdown指南
• Mastering Markdown by GitHub

工具与资源：

• Awesome Markdown：Markdown工具和资源集合
• Markdown Here：浏览器扩展，将Markdown转换为HTML
• Pandoc：万能文档转换器

社区与论坛：

• Stack Overflow：Markdown相关问题
• Reddit r/Markdown：Markdown社区讨论
• GitHub Community：GitHub上的Markdown讨论

通过不断实践和学习，你将能够熟练掌握Markdown，并将其应用到各种文档编写场景中，提高你的写作效率和文档质量。
「七転び八起き（ななころびやおき）」
回复

使用道具 举报

返回列表 发新帖
您需要登录后才可以回帖 登录 | 立即注册
高级模式
B Color Image Link Quote Code Smilies

本版积分规则