Learning Markdown

网上教程很多,自己整理一份最基础的功能,以及排版注意事项。

工具篇

Typora

  • 免费
  • Windows / MacOS / Linux
  • 纯 markdown 功能,没有标签管理能力
  • 全平台所见即所得,好用且免费,强烈推荐

有道云笔记

  • 免费
  • Windows / MacOS / Linux
  • 太常见的工具,不多介绍了

Bear熊掌记

  • 收费。免费可使用基础功能
  • 支持 MacOS
  • 支持文章标签等管理
  • 不是完美支持 markdown 语法,比较遗憾
  • 外观非常好看,很多人推荐,适合写作,不适合程序员

mWeb

  • 收费
  • 支持 MacOS
  • 支持文章等管理,甚至是图片上传图床
  • 我认为是唯独一个可以一边写markdown一遍看效果,并且滚动不卡的APP

绝大部分编辑器

都有 markdown 的原生支持或者插件支持。

专业的付费写作软件

Ulysses 等,因为收费太贵,所以没接触过。

排版篇

1. 留空行

写一行内容,后续一行要留空,否则会变成一行内容。

部分语法除外。主要涉及多行块元素,不要留空。主要有:

  • 列表类(*/数字开头)
  • 表格
  • 引用

例如:

1
2
3
这是第一行内容
--> 这行空着
这是第二行内容
1
2
* 无需列表项目1
* 无需列表项目2 -->两行之间,不加空行

2. 留空格

行的块元素,一般要留空格,否则可能有的编辑器解析不了。但行内元素,不能加空格。

例如:

1
2
3
4
5
* 这是列表元素
> 这是引用内容
# 这是大标题H1
^
这里都有一个空格
1
2
3
**着重说明内容**
^
这里都没有空格

语法篇

标题

可以定义 H1~H6 标题,一般常用:

  • H1 页面标题
  • H2 页面大栏目
  • H3-H4 子栏目

例如:

1
2
3
4
5
# 这是H1

## 这是H2

### 这是H3

一般现在常用上侧写法,可能你会看到如下写法,以下写法可能有的编辑器不能支持:

1
2
3
4
# 这是H1 #    --> 结尾和头部对称

这是H1
====== --> 使用等号或横线表示标题

链接

1
[我的博客](https://www.yukapril.com)

图片

1
![LOGO](https://www.yukapril.com/logo.png)

中括号内为图片 alt 内容,可以不写。

文字效果

1
在这段内容中,*斜体*是这样的,**加粗**这么写,==高亮==效果和编辑器有关,~~删除线~~是这个效果。注意并不是所有编辑器都能支持以上效果。

效果就是:

在这段内容中,斜体是这样的,加粗这么写,==高亮==效果和编辑器有关,删除线是这个效果。注意并不是所有编辑器都能支持以上效果。

引用

1
2
3
4
5
6
7
> 这里是需要引用的文本

> 如果引用多行内容,
>
> 那么请注意,
>
> 可能需要这样写

有的编辑器引用的内容也要留有空行,但是引用符号不可省略。

分割线

1
2
3
====

****

这两种都可以生成分割线,一般常见都是 4 个字符,但最少用 3 个字符也可以生效。

区别上,可能用星号粗一些,等号窄一些。这要看编辑器自己的实现。有的编辑器不能识别等号写法。

代码块


1
var abc = ''

用三个反斜杠表示,后可以接语言类型,有的编辑器可以进行高亮显示。

行内代码

1
在一个项目中,我加入了 `var hmt = []` 这句代码解决了问题。

效果:

在一个项目中,我加入了 var hmt = [] 这句代码解决了问题。

列表

1
2
3
4
5
6
7
* 无序列表1
* 无序列表1.1
* 无序列表1.2
* 无序列表2

1. 有序列表1
2. 有序列表2

无序列表,可以用星号 *,也可以用短线 -,还可以用 +

有序列表需要使用数字后跟英文句号 .,而且数字无所谓多少,都是从 1 开始排序

代办事项

1
2
- [ ] 未完成事项
- [x] 已完成事项

代办事项,可以用星号 *,也可以用短线 -。选中项目,中括号内有个 x

表格

列1(默认左对齐) 列2(左对齐) 列3(右对齐) 列4(居中对齐)
文字 文字 文字 文字
文字 文字 文字 文字

第一行为行标题,第二行为对齐方式,后续为每一行内容。对齐方式中的符号,至少有三个字符(可以无限加入短线 -)。

对齐方式:

  • :-- 代表左对齐
  • --: 代表右对齐
  • :--:代表居中对齐

不常用功能

由于不常用,我也不太会。

比如脚注。

图表、TOC、LaTeX 公式等其他功能

这些功能属于扩展功能,需要 markdown 编辑器额外实现(或引入相关功能插件),由于编辑器实现方式不同,故没有特别统一的写法。

唯独 LaTeX 公式 比较统一,只要是编辑器支持,基本上写法都差不太多。

HTML 兼容语法

由于 markdown 兼容 HTML 语法,所以完全可以在 markdown 中写 HTML。😀

参考

Daring Fireball: Markdown Syntax Documentation