可乐炸鸡

V1

2023/05/26阅读:33主题:橙心

Markdown 写作入门指北

Markdown 写作入门指北

作为技术人员对 Markdown 应该是不会陌生的,不管是CSDN、掘金、GitHub,还是自己搭建博客,Markdown 都能让我们非常高效率地进行写作。

掘金编辑页面
掘金编辑页面

Markdown 是什么?

Markdown 是一种轻量级的标记语言,可用于在纯文本文档中添加格式化元素。Markdown 由 John Gruber 于 2004 年创建,如今已成为世界上最受欢迎的标记语言之一。

简单点说就是,Markdown 可以让你在写作的时候只需要专注于文字内容而并不需要特别在意排版。

Markdown 优点

  1. 轻量级:Markdown语法非常轻量,且学习成本低,只需几个小时就能掌握。
  2. 纯文本:Markdown文件为纯文本文件,易于阅读和编辑,且兼容所有文本编辑器和字处理软件。
  3. 强大的排版能力:Markdown语法简单明了,但能够实现复杂的排版效果,如标题、列表、引用、代码块等。
  4. 广泛的工具支持:许多工具和软件都支持Markdown,如编辑器、博客平台、版本控制系统等。
  5. 轻松的导出格式:Markdown支持导出多种格式,如HTML、PDF、电子书等,方便用户在不同场合使用。
  6. 专注于内容:Markdown语言强调专注于内容,减少了对排版样式的关注,让用户更加专注于写作本身。
  7. 跨平台:Markdown语言可以在不同平台上使用,无论是Windows、macOS还是Linux,都能轻松编辑和阅读Markdown文件。

Markdown 常用简单用法

标题

要创建标题,请在单词或短语前面添加井号 (#) 。

标题 Markdown 语法
一级标题 # 一级标题
二级标题 ## 二级标题
三级标题 ### 三级标题
... ...
六级标题 ###### 六级标题

文字格式

要加粗文本,请在单词或短语的前后各添加两个星号*

Markdown 语法 渲染效果
**粗体** 粗体
*斜体* 斜体
粗体加斜体 粗体加斜体
~~删除线~~ 删除线

有序列表

每个列表项前添加数字并紧跟一个英文句点。

语法:

1. 列表项1
   1. 列表项1.1
2. 列表项2
3. 列表项3

效果:

  1. 列表项1
    1. 列表项1.1
  2. 列表项2
  3. 列表项3

无序列表

语法:

列表项a
  - 列表项aa
列表项b
列表项c

效果:

  • 列表项a
    • 列表项aa
  • 列表项b
  • 列表项c

图片

要添加图片,首先请添加感叹号(!),然后紧跟着是方括号,方括号中可添加替代文本(alt text,即图片显示失败后显示此文本),最后跟着圆括号,圆括号中添加图片资源的路径或 URL。

![The San Juan Mountains are beautiful!](https://www.markdown.xyz/assets/images/san-juan-mountains.jpg "San Juan Mountains")

效果:

The San Juan Mountains are beautiful!
The San Juan Mountains are beautiful!

代码

要将单词或短语表示为代码,请将其包裹在反引号 (`) 中。

Markdown 语法 渲染效果
`代码` 代码

代码块

要创建代码块,代码块的前后可以使用三个反引号(```)来标记围栏代码块。``` 后面跟随编写代码所用的编程语言,会将代码语法高亮。

语法:

```json
{
  "firstName": "John",
  "lastName": "Smith",
  "age": 25
}
```

效果:

{
  "firstName""John",
  "lastName""Smith",
  "age"25
}

链接

语法:

[举例🌰](http://www.example.com)

显示效果:举例🌰

表格

如需添加表格,请使用三个或更多个连字符(---)来为每个列创建表头,并使用管道符(|)来分隔每个列。为兼容考虑,你还应该在行的两侧添加管道符。

语法:

| Markdown 语法      | 渲染效果 |
| ----------- | ----------- |
| 内容      | 效果       |
| 内容1   | 效果1        |

显示效果:

Markdown 语法 渲染效果
内容 效果
内容1 效果1

其他

以上为常用语法,针对其他语法或者进阶语法可以参考:*Markdown 指南* [1]

Markdown 编辑器推荐

Markdown 编辑器有很多,在这里举例用过的几款。

  1. Typora[2]:这是一个广受欢迎的 Markdown 编辑器,支持实时预览和多种主题。收费。
  2. Visual Studio Code[3]:这是一款强大的代码编辑器,支持 Markdown 编辑和实时预览。需配置
  3. 有道云笔记[4]:内置Markdown编辑器和使用指南,非技术类用户也可快速上手,无需再纠结排版,创造更加优雅的沉浸式记录体验。云平台

Markdown 文章发布

在我们写完文章之后,当想要发布到技术论坛、公众号上的时候,就非常简单了。当然,不同平台之间语法稍有差异,大家可以在使用的是发现了,在这里推荐两个常用的 Markdown 排版美化平台。

  • 掘金[5]:掘金提供了支持 Markdown 编辑器并附带主题可选,原文导入即可。
  • 墨滴[6]:是一款支持自定义样式的在线 MarkDown 编辑器,可以一键切换常见公众号样式的排版及导出。
墨滴编辑页面
墨滴编辑页面

最后,完成这份 Markdown 写作入门指北的时候,简单的写作排版发布应该不是问题了,如果有更多的需求,可以再去学习一些高级技巧,比如,数学公式块、YAML Front Matter、图表、目录、HTML标签等。

参考资料

[1]

Markdown 指南: https://www.markdown.xyz/

[2]

Typora: https://typora.io/

[3]

Visual Studio Code: https://code.visualstudio.com/

[4]

有道云笔记: https://note.youdao.com/

[5]

掘金: https://juejin.cn/

[6]

墨滴: https://www.mdnice.com/

分类:

前端

标签:

前端

作者介绍

可乐炸鸡
V1