🏠 首页 攻略 Markdown是什么?程序员写文档都在用的轻量级语法

Markdown是什么?程序员写文档都在用的轻量级语法

Markdown是一种轻量级标记语言,用简单的符号就能写出漂亮的文档。GitHub、博客、笔记软件都在用它。本文从零开始,5分钟学会Markdown写作。

Markdown是什么?程序员写文档都在用的轻量级标记语言

你有没有遇到过这种情况:写了一份文档,发给同事后格式全乱。标题变正文、列表对齐了、代码缩进没了,看着就头疼。

Markdown就是来解决这个问题的。John Gruber在2004年创造了它,核心思路就一个:用最简单的符号,写出结构清晰的文档,然后一键转成漂亮的HTML。

今天花了5分钟,学会这套语法。


一、Markdown是什么?

Markdown是一种轻量级标记语言。它用普通的文本符号来标记格式,不需要像Word那样拖拽按钮设置样式。

打个比方:Markdown就像写邮件时用的加粗和列表,只不过它定义了一套完整规则,任何支持Markdown的工具都能识别。

为什么这么流行?

  • 纯文本格式,任何编辑器都能打开
  • 语法简单,半天就能上手
  • 通用性强,GitHub、博客、笔记软件都支持
  • 写完后能一键转成HTML、PDF、Word等格式

二、基础语法速查

标题

用井号表示,一个井号最大,七个最小:

# 一级标题
## 二级标题
### 三级标题

渲染效果:

一级标题

二级标题

三级标题

段落和换行

正常写字就是段落。两个回车换一段。

一个回车不算换行,要换行就在行尾加两个空格。

加粗和斜体

**这是加粗**
*这是斜体*
***这是加粗斜体***

这是加粗 这是斜体 这是加粗斜体

列表

无序列表用减号或星号:

- 第一项
- 第二项
  - 子项
  • 第一项
  • 第二项
    • 子项

有序列表用数字加点:

1. 第一步
2. 第二步
3. 第三步
  1. 第一步
  2. 第二步
  3. 第三步

引用

用大于号:

> 这是一段引用
> 可以换行继续写

这是一段引用 可以换行继续写

代码

行内代码用反引号:

`print("hello")` 输出内容

print("hello") 输出内容

代码块用三个反引号:

```python
def hello():
    print("Hello, Markdown!")

```python
def hello():
    print("Hello, Markdown!")

链接和图片

[链接文字](https://example.com)
![图片描述](https://example.com/image.png)

链接文字 图片描述

表格

用竖线和中横线:

| 功能 | 语法 | 示例 |
|------|------|------|
| 加粗 | **文字** | **加粗** |
| 斜体 | *文字* | *斜体* |
| 链接 | [文字](URL) | [百度](https://baidu.com) |
功能语法示例
加粗文字加粗
斜体文字斜体
链接文字百度

三、Markdown在实际中的应用

GitHub上的README

打开任何一个GitHub项目,README文件基本都是Markdown写的。这也是为什么程序员学Markdown几乎是必修技能。

笔记软件

Typora、Obsidian、Notion都支持Markdown。你在Typora里写Markdown,它直接渲染成漂亮格式,所见即所得。

博客平台

Hexo、Hugo、Jekyll这些静态博客框架都用Markdown写文章。你写的.md文件,编译后就是网站上的HTML页面。

文档编写

很多技术文档、API说明都用Markdown写,比如Vue.js官方文档、React文档都是Markdown源码。


四、怎么开始用Markdown?

最简单的起步方式:

  1. 下载一个Markdown编辑器

    • Typora(Mac/Windows,所见即所得)
    • VS Code(装Markdown插件,程序员首选)
    • Obsidian(笔记+知识库)
  2. 找一个支持Markdown的平台练手

    • GitHub新建一个仓库,写README
    • 在小红书或知乎写文章时切到Markdown模式
  3. 把日常笔记换成Markdown格式

一个实用技巧: 在VS Code里新建一个.md文件,左边编辑,右边预览,写出来就是成品。


总结

Markdown就是用简单的符号控制格式的语言。它不复杂,学会十几条语法就能应付99%的场景。

你现在就可以打开一个文本编辑器,随便写点什么,保存为.md后缀,然后用Typora或VS Code打开预览。很快你就会发现:写文档比用Word顺手多了。

下次在GitHub上看到别人的README,或者同事分享的文档链接,试试用Markdown自己写一份。