当前位置: 首页 > news >正文

Markdown 全面教程:从基础到高级

Markdown 全面教程:从基础到高级

Markdown 是一种轻量级的标记语言,它的设计目标是使书写和阅读文档变得简单而直观。无论是撰写博客、编写文档还是创建 README 文件,Markdown 都是一个非常实用的工具。
在这里插入图片描述

目录

  1. Markdown 简介
  2. Markdown 的基本语法
    • 标题
    • 段落与换行
    • 列表
    • 链接
    • 图片
    • 强调
    • 代码
    • 引用
    • 水平线
  3. Markdown 的高级用法
    • 表格
    • 任务列表
    • 脚注
    • 定义列表
  4. Markdown 的扩展
    • GitHub Flavored Markdown
    • Markdown 解析器
  5. Markdown 编辑器推荐
  6. Markdown 的应用场景
  7. 总结与展望

Markdown 简介

Markdown 是由约翰·格鲁伯(John Gruber)于 2004 年创建的一种轻量级标记语言。它的目标是让人们能够使用易读易写的纯文本格式来编写文档,然后转换成结构化的 HTML 文档。由于其简单的语法和广泛的应用,Markdown 逐渐成为技术文档、博客文章、电子书等多种场景下的首选格式。

Markdown 的特点

  • 易读性:Markdown 文档在未转换为 HTML 的情况下,仍然具有良好的可读性。
  • 简洁性:Markdown 语法简单,易于学习和使用。
  • 可扩展性:Markdown 可以通过扩展实现更多功能。

Markdown 的基本语法

标题

Markdown 使用 # 符号来表示标题。标题的级别由 # 的数量决定,最多可以有六级标题。

# 一级标题
## 二级标题
### 三级标题
#### 四级标题
##### 五级标题
###### 六级标题

效果:

一级标题

二级标题

三级标题

四级标题
五级标题
六级标题

段落与换行

段落通过空行分隔。要在段落中换行,可以在行末添加两个或多个空格,然后按回车。

这是第一段。这是第二段。

效果:

这是第一段。

这是第二段。

要换行:

这是第一行。  
这是第二行。

效果:

这是第一行。
这是第二行。

列表

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

无序列表

使用 *+- 表示无序列表项。

- 项目 1
- 项目 2- 子项目 2.1- 子项目 2.2

效果:

  • 项目 1
  • 项目 2
    • 子项目 2.1
    • 子项目 2.2
有序列表

使用数字加点表示有序列表。

1. 第一项
2. 第二项1. 子项 2.12. 子项 2.2

效果:

  1. 第一项
  2. 第二项
    1. 子项 2.1
    2. 子项 2.2

链接

Markdown 使用方括号 [] 表示链接文本,后跟圆括号 () 表示链接地址。

[百度](https://www.baidu.com)

效果:

百度

图片

插入图片的语法与链接类似,只需在前面加一个感叹号 !

![替代文本](https://example.com/image.png)

效果:

在这里插入图片描述

强调

使用 *_ 来表示强调(斜体),使用 **__ 来表示加粗。

*斜体文本* 或 _斜体文本_
**加粗文本** 或 __加粗文本__

效果:

斜体文本斜体文本
加粗文本加粗文本

代码

要插入行内代码,可以使用反引号 ` 包裹代码。

这是 `inline code` 示例。

效果:

这是 inline code 示例。

要插入多行代码,可以使用三个反引号 ```````````或者缩进四个空格。

function hello() {
console.log(“Hello, World!”);
}

效果:

function hello() {console.log("Hello, World!");
}

引用

使用 > 表示引用。

> 这是一个引用的示例。

效果:

这是一个引用的示例。

水平线

使用三个或更多的 *-_ 表示水平线。

---

效果:


Markdown 的高级用法

表格

Markdown 支持表格的创建,使用 | 分隔列,- 表示表头的分隔。

| 列1 | 列2 | 列3 |
|-----|-----|-----|
| 数据1 | 数据2 | 数据3 |
| 数据4 | 数据5 | 数据6 |

效果:

列1列2列3
数据1数据2数据3
数据4数据5数据6

任务列表

使用 [ ][x] 来表示未完成和已完成的任务。

- [x] 完成任务 1
- [ ] 完成任务 2

效果:

  • 完成任务 1
  • 完成任务 2

脚注

脚注可以用来添加注释或引用。

这是一个脚注示例[^1]。[^1]: 这是脚注的内容。

效果:

这是一个脚注示例1

定义列表

定义列表用于定义术语和其描述。

Markdown
: 一种轻量级的标记语言。HTML
: 超文本标记语言。

效果:

Markdown
一种轻量级的标记语言。
HTML
超文本标记语言。

Markdown 的扩展

GitHub Flavored Markdown

GitHub 对 Markdown 进行了扩展,增加了许多实用功能,如表格、任务列表、自动链接等。这使得在 GitHub 上撰写文档变得更加方便。

Markdown 解析器

有多种 Markdown 解析器可以将 Markdown 转换为 HTML。常用的解析器包括:

  • Marked.js:一个高性能的 Markdown 解析器。
  • Showdown:一个 JavaScript Markdown 转换器。
  • Markdown-it:一个支持插件的 Markdown 解析器。

Markdown 编辑器推荐

以下是一些流行的 Markdown 编辑器,适合不同需求的用户:

  1. Typora:一款所见即所得的 Markdown 编辑器,支持实时预览。
    在这里插入图片描述

  2. Visual Studio Code:强大的代码编辑器,支持 Markdown 插件。
    在这里插入图片描述

  3. MarkdownPad:Windows 平台上的 Markdown 编辑器,界面友好。
    在这里插入图片描述

  4. StackEdit:基于浏览器的 Markdown 编辑器,支持云同步。
    在这里插入图片描述

Markdown 的应用场景

Markdown 被广泛应用于以下场景:

  • 技术文档:编写项目文档、API 文档等。
  • 博客文章:撰写博客,特别是技术类博客。
  • 电子书:编写电子书,方便转换为多种格式。
  • README 文件:在 GitHub 等平台上编写项目的 README 文件。

总结与展望

Markdown 是一种简单而强大的标记语言,适用于多种文档编写场景。通过本文的学习,相信你已经掌握了 Markdown 的基本语法和高级用法。随着 Markdown 的不断发展和扩展,其应用场景也在不断扩大。希望你能在实际工作中灵活运用 Markdown,提高文档的编写效率。

如有任何疑问或建议,欢迎在评论区留言讨论!希望本教程对你有所帮助,期待你在 Markdown 的学习和应用中取得更大的进展。


以上是关于 Markdown 的详细教程,希望内容丰富且具有实用性。如果需要更深入的探讨或具体的例子,请随时告知!


  1. 这是脚注的内容。 ↩︎


http://www.mrgr.cn/news/67964.html

相关文章:

  • Map函数与vector<pair<int,int>>函数的使用方法
  • Browserslist 配置
  • EPSON机械手与第三方相机的校准功能设计By python
  • Python 单元测试中的 Mocking 与 Stubbing:提高测试效率的关键技术
  • Python进阶之IO操作
  • 2024年11月6日Day6
  • salesforce批量修改对象字段的四种方法
  • VScode建立Java项目
  • 一文带你深度了解FreeRTOS——递归互斥信号量
  • 2024年网鼎杯青龙组|MISC全解
  • Jest项目实战(5):发布代码到 npm
  • 矩阵论 •「线性空间、基变换与向量坐标变换」
  • Jest项目实战(4):将工具库顺利迁移到GitHub的完整指南
  • yakit中的fuzztag
  • Ubuntu安装Python并配置pip阿里镜像教程 - 幽络源
  • bat批量处理脚本细节研究
  • 什么是干部民主测评系统?如何选择合适的系统?
  • 论文 | Teaching Algorithmic Reasoning via In-context Learning
  • 基于STM32的智能花园灌溉系统设计
  • golang笔记-Array(数组)
  • Java LeetCode练习
  • Rust语言为什么在2024年依然流行?真的安全、快速又可靠吗?
  • 【数学二】线性代数-向量-向量组的秩、矩阵得秩
  • 可信度模型
  • Java 网络编程(一)—— UDP数据报套接字编程
  • 全卷积和全连接