Markdown Example
Markdown 是一种轻量级标记语言,创始人为约翰·格鲁伯(英语:John Gruber)。它允许人们“使用易读易写的纯文本格式编写文档,然后转换成有效的 XHTML (或者 HTML )文档”
下面简单讲解一些关于 Markdown
的语法规则
你也可以参考一下文档:
Markdown 笔记
目录
使用 [TOC]
就可以生成目录
示例:
标题
在 Markdown
中如果一段文字被定义为标题,则加入 # 号即可。
以此类推,总共六级标题,建议在井号后加一个空格,这是最标准的 Markdown 语法。
# 标题H1
## 标题H2
### 标题H3
#### 标题H4
##### 标题H5
###### 标题H6
示例:
标题H1
标题H2
标题H3
标题H4
标题H5
标题H6
强调
斜体
斜体的语法是用 _
或者 *
包裹
_这是斜体,在前后加入一个_
*这也是斜体*
示例:
这是斜体,在前后加入一个
这也是斜体
粗体
粗体的语法是用 **
包裹
**粗体**
示例:
这是普通字体
这是粗体
删除线
粗体的语法是用 ~~
包裹
~~这是删除线~~
示例:
这是删除线
代码 Code
行内代码块
用 `Code` 来包住文字表示行内代码块
示例:
这是一个行内 Code
代码块
有两种方式:
- 用``` Code```包住代码代表代码块
- 用四个空格的缩进代表代码块
示例:
for i in range(10, 51):
if 1 <= i % 10 <= 5:
print(i)
列表
无序列表(减号 - 、加号 +、星号 * )
+ 列表一
- 列表二
* 列表三
示例:
- 列表一
- 列表二
- 列表三
无序列表(嵌套 +、-、* )
- 列表一
+ 列表二
+ 列表二-1
- 列表二-2
* 列表二-3
+ 列表二-3-1
- 列表二-3-2
示例:
- 列表一
- 列表二
- 列表二-1
- 列表二-2
- 列表二-3
- 列表二-3-1
- 列表二-3-2
有序列表
1. 列表一
2. 列表二
3. 列表三
示例:
- 列表一
- 列表二
- 列表三
Emoji 😄
如果要打出笑脸 emoji,那么输入 :smile:
分割线
分割线的语法只需要另起一行,连续输入三个星号***
或者段括号 ---
即可。
表格
Markdown 中的默认表格格式如下:
| 普通标题 | 普通标题 | 普通标题 |
| ------ | ------ | ------ |
| 这是文本 | 这是一个文本 | 这是一个 Markdown 文本 |
| 这是又是一个 Markdown 文本 | 这是文本 | 这是还是一个文本 |
示例:
普通标题 | 普通标题 | 普通标题 |
---|---|---|
这是文本 | 这是一个文本 | 这是一个 Markdown 文本 |
这是又是一个 Markdown 文本 | 这是文本 | 这是还是一个文本 |
Markdown 中的不同对齐表格格式如下:
| 左对齐标题 | 居中对齐标题 | 右对齐标题 |
| :------ | :------: | ------: |
| 这是文本 | 这是一个文本 | 这是一个 Markdown 文本 |
| 这是又是一个 Markdown 文本 | 这是文本 | 这是还是一个文本 |
示例:
左对齐标题 | 居中对齐标题 | 右对齐标题 |
---|---|---|
这是文本 | 这是一个文本 | 这是一个 Markdown 文本 |
这是又是一个 Markdown 文本 | 这是文本 | 这是还是一个文本 |
To-Do 列表
- [ ]
代表了未完成
- [X]
代表了已完成
示例:
引用
这是一段引用的文字,通过在文字前面加一个
>
符号
插入图片
![描述](图片链接地址)
示例:
扩展语法
高亮文本
==文本高亮==
示例:
高亮文本
上标
上标使用^
包裹,比如 2^10^
示例:
210
下标
下标使用~
包裹,比如 H~2~O
示例:
H20
缩略信息
Github 是软件源代码托管服务平台。
*[Github]: 全球最大同性交流网站,AKA: GayHub.
示例:
Github 是软件源代码托管服务平台。
脚注
脚注通过 [^1]
来表示。
这是一个脚注[^1],这是另一个[^脚注2]
然后在任意地方写
[^1]: 内容即可
Markdown 写作软件
Typora 是一款多平台写作软件,强烈推荐,所见即所得的写作体验能够更加享受 Markdown 写作时的沉浸感,此篇文档便是由 Typora 编写而成。
NEW WAY TO READ & WRITE MARKDOWN.
I THINK THIS IS THE ONE, ❤ IT.
A TRULY MINIMAL MARKDOWN EDITOR.
这就是 Typora 的信条
以下是推荐的一些 Markdown 写作软件的下载网址以及支持的平台
平台 | macOS | WIN | Linux | iOS | Android |
---|---|---|---|---|---|
Typora | ✔ | ✔ | ✔ | ||
Bear | ✔ | ✔ | |||
Visual Studio Code | ✔ | ✔ | ✔ | ||
Simplenote | ✔ | ✔ | ✔ | ✔ | ✔ |
Sublime Text 3 | ✔ | ✔ | ✔ | ||
Evernote | ✔ | ✔ | ✔ | ✔ | |
Yu Writer | ✔ | ✔ | ✔ | ||
iA Writer | ✔ | ✔ | ✔ | ✔ | |
有道云笔记 | ✔ | ✔ | ✔ | ||
马克飞象 | ✔ | ✔ | |||
Byword | ✔ | ✔ | |||
Mou | ✔ |