Markdown 实用语法解析

阿粉总觉得之前自己写的文档很丑,有没有什么好的、先进的文档编写格式呢?网上一搜有个东西叫 markdown 让阿粉觉得不得了啊,赶紧学了一波~真刺激。

image-20200328053444188

Markdown 是什么

Markdown是一种轻量级标记语言,是一种方便记忆、书写的纯文本标记语言。目前各大知识内容平台例如知乎,简书都支持用户使用 Markdown 进行快速编辑,他同时也是全球最大的技术分享网站 GitHub 和技术问答网站 StackOverFlow 的书写格式。

为什么要用 Markdown

  • 它是易读(看起来舒服)、易写(语法简单)、易更改纯文本
  • 兼容 HTML,可以转换为 HTML 格式发布。
  • 跨平台使用。
  • 全球最大的同性交友网站(偷笑)支持 Markdown
  • 更方便清晰地组织你的电子邮件。
  • 摆脱Word(我不是认真的)。

Markdown 的参考网站

这里可以看到官方的 Markdown 语法规则文档,当然,后文我也会用自己的方式,阐述这些语法在实际使用中的用法。

Markdown 编辑器推荐

Typora

Typora 是一款非常强大的 Markdown 编辑器,支持 Windows、OS X 和 Linux,Typora 支持即时渲染技术,这也是与其他 Markdown 编辑器最显著的区别,Typora 适合那些对码字手速和排版顺畅度有要求的人群。

点击此处访问 Typora 官网

Typora 有一个缺点,就是容易造成机器卡死,丢失信息。

Visual Studio Code

Visual Studio Code 是众所周知的神器,是微软推出一款轻量级的文本编辑工具,类似于 Sublime text,它已经默认集成 Markdown 文档编辑插件,原生就支持高亮 Markdown 的语法,但想要实时预览还需要选择 Open Preview to the Side 命令实现,相关教程请点击此处点击此处 访问 Visual Studio Code 官网

Sublime Text 3

Sublime Text 3 可以免费试用,支持 OS X、Windows、Ubuntu 等 UNIX 及 Linux 操作系统,由于其功能的多样性而广受好评,界面简约大方,定位专业,原生支持的编程语言就多达十几种,通过第三方插件,还能实现更多语法的支持,其中就包括 Markdown ,但也有个缺点,就是不能实时预览,但是用户可以 通过 Markdown Preview 的插件实现对 Markdown 的预览,具体教请点击此处查看,点击此处访问 Sublime Text 官网

Atom

Atom 是 Github 专门为程序员推出的一个跨平台文本编辑器,具有简洁和直观的图形用户界面,并有很多有趣的特点:支持CSS,HTML,JavaScript等网页编程语言,当然也支持 Markdown ,支持宏,自动完成分屏功能,集成了文件管理器,点击此处访问 Atom 官网

MWeb

MWeb 是一款 macOS 上体验优秀的 Markdown 应用,在 Markdown 编辑器同质化严重的今天,MWeb 以其出色的功能和体验独树一帜:

  • 跨 macOS 和 iOS 的双平台;
  • 内置灵活的文档库管理功能;
  • 支持在应用内生成和发布静态博客,并用 GitHub 等平台托管图片资源;
  • 可以直接发布文章到 WordPress、Medium、新浪博客等平台;
  • 支持以标签管理 Markdown 文档;
  • 可用于搭建个人 Wiki 知识库。

Mou

一款由国人独立开发者 罗晨 开发的实时预览型 Markdown 编辑器,也因此成为(目前)同类应用中,对汉字兼容性最好的代表作。不信?你一用便知。反过来讲,要论它有多人性化,我有点说不上来,毕竟每个人都有自己的偏好、习惯和审视角度,任何文章作者都不能以偏概全,但有一点是为大众认可的——Mou 是目前最好用的免费 Markdown 编辑器,没有之一!

好了,安装完软件后,阿粉开始起飞了。

Markdown 实用语法

标题

语法格式:

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

对应效果:

一级标题

二级标题

三级标题

按这种格式往下类推,共有六级标题,记住#要与标题文本间有空格

列表

无序列表

语法格式: * 1- 1 * 2- 2 * 3- 3 对应效果:

  • 1
  • 2
  • 3

在文字前加上一个字符的空格再加上\*-就可以形成无序列表;在文字前加上一个字符的空格再加上1. 2. 3.就可以形成有序列表

文字样式

1
2
3
4
5
6
7
8
9
*这些文字会生成斜体*
_这些文字会生成下划线_

~~这是一段错误的文本~~

**这些文字会生成加粗**
__这些文字会生成加粗__
***这些文字会生成斜体加粗***

对应的效果如下

这些文字会生成斜体 这些文字会生成下划线

这是一段错误的文本

这些文字会生成加粗 这些文字会生成加粗 *这些文字会生成斜体加粗*

分割线

可以在一行中用 3 个以上的 *-_ 来建立一个分隔线:

Markdown 语法:

1
2
3
* * *
- - -
_ _ _

效果如下:




引用

> 这是一段引用文字 对应效果:

这是一段应用文字

要注意>和引用文字之间有一个字符的空格

链接

使用:[描述](链接地址) ,为文字增加链接:

1
这是去往 [Github](https://github.com/) 的链接。

效果如下:

这是去往 Github 的链接。

单行代码

语法格式: 用两个 “ ` ”号 来包裹你的代码

对应效果: 你的代码

多行代码

语法格式:

上面是使用一个 ,这里是使用三个 ``,结尾也是。

对应效果:

代码

表格

Markdown 语法:

1
2
3
4
5
| 项目(左对齐) | 价格(右对齐) | 数量(居中) |
| :--- | ---: | :---: |
| 计算机 | 1600 | 5 |
| 手机 | 12 | 12 |
| 管线 | 1 | 234 |

效果如下:

项目(左对齐) 价格(右对齐) 数量(居中)
计算机 1600 5
手机 12 12
管线 1 234

但我一般喜欢手动直接插入表格。

文章参考:

https://www.jianshu.com/p/1d90cd988fa1

https://sspai.com/post/27792

https://blog.csdn.net/qq_36759224/article/details/82229243

https://zhuanlan.zhihu.com/p/92312642

https://sspai.com/post/25137

https://blog.csdn.net/weixin_43189735/article/details/84317145

Java Geek Tech wechat
欢迎订阅 Java 极客技术,这里分享关于 Java 的一切。