Markdown 入门文档


Markdown 介绍:

  • Markdown 是一种轻量级标记语言,它允许人们使用易读易写的纯文本格式编写文档。

  • Markdown 语言在 2004 由约翰·格鲁伯(英语:John Gruber)创建。

  • Markdown 编写的文档可以导出 HTML 、Word、图像、PDF、Epub 等多种格式的文档。

  • Markdown 编写的文档后缀为 .md, .markdown。


Markdown 应用:

  • Markdown 能被使用来撰写电子书,如:Gitbook。

  • 当前许多网站都广泛使用 Markdown 来撰写帮助文档或是用于论坛上发表消息。例如:GitHub、简书、reddit、Diaspora、Stack Exchange、OpenStreetMap 、SourceForge 等。


Markdown 编译器:

  • Typora
    优点:中文,简洁
    缺点:收费,没有第三方插件
  • Obsidian
    有点:免费,有第三方插件,可视化编辑
    缺点:复杂
  • 简书
  • VSCode

1. Markdown 段落格式


1.1 标题

  • 使用 # 号标记
    使用 # 号可表示 1-6 级标题,一级标题对应一个 # 号,二级标题对应两个 # 号,以此类推。
# 一级标题
## 二级标题
### 三级标题
#### 四级标题
##### 五级标题
###### 六级标题

1.2 字体

*斜体文本*
_斜体文本_
**粗体文本**
__粗体文本__
***粗斜体文本***
___粗斜体文本___
  • 效果如下所示:

    斜体文本
    斜体文本
    粗体文本
    粗体文本
    粗斜体文本
    粗斜体文本


1.3 分隔线

  • 你可以在一行中用三个以上的星号、减号、底线来建立一个分隔线,行内不能有其他东西。你也可以在星号或是减号中间插入空格。下面每种写法都可以建立分隔线:
***
* * *
*****
---
- - -
----------
  • 效果如下所示:







1.4 删除线

  • 如果段落上的文字要添加删除线,只需要在文字的两端加上两个波浪线 ~~ 即可,实例如下:
RUNOOB.COM
GOOGLE.COM
~~BAIDU.COM~~
  • 效果如下所示:
    RUNOOB.COM
    GOOGLE.COM
    BAIDU.COM

1.5 下划线

  • 下划线可以通过 HTML 的 <u> 标签来实现:
<u>带下划线文本</u>

带下划线文本


2. Markdown 列表


2.1 有序列表和无序列表

  • Markdown 支持有序列表和无序列表。
  • 无序列表使用星号(*)、加号(+)或是减号(-)作为列表标记,这些标记后面要添加一个空格,然后再填写内容:
* 第一项

+ 第二项

- 第三项
  • 效果如下所示:

  • 第一项

  • 第二项
  • 第三项

有序列表使用数字并加上 . 号来表示,如:

1. 第一项
2. 第二项
3. 第三项
  • 效果如下所示:
  1. 第一项
  2. 第二项
  3. 第三项

2.2 列表嵌套

列表嵌套只需在子列表中的选项前面添加四个空格即可:

1. 第一项:
- 第一项嵌套的第一个元素
- 第一项嵌套的第二个元素
2. 第二项:
- 第二项嵌套的第一个元素
- 第二项嵌套的第二个元素
  1. 第一项:
    • 第一项嵌套的第一个元素
    • 第一项嵌套的第二个元素
  2. 第二项:
    • 第二项嵌套的第一个元素
    • 第二项嵌套的第二个元素

3. Markdown 代码


3.1 段落代码

  • 如果是段落上的一个函数或片段的代码可以用反引号把它包起来`内容`,例如:
    `printf()` 函数
  • 效果如下所示:
`printf()` 函数

3.2 代码区块(多行代码)

  • 代码区块使用可以用 ```内容``` 包裹一段代码,并指定一种语言(也可以不指定)实例如下:

```
public class hello {
public static void main(String[] args) {
System.out.println(“Hello,World”);
}
}
```

  • 效果如下所示:
public class hello {
public static void main(String[] args) {
System.out.println("Hello,World");
}
}

4. Markdown 链接


链接基础

[链接名称](链接地址)
或者
<链接地址>

列如:
这是一个链接 [菜鸟教程](https://www.runoob.com)


高级链接

这个链接用 1 作为网址变量 [Google][1]
这个链接用 runoob 作为网址变量 [Runoob][runoob]
然后在文档的结尾为变量赋值(网址)
[1]: http://www.google.com/
[runoob]: http://www.runoob.com/
  • 效果如下所示:

这个链接用 1 作为网址变量 Google
这个链接用 runoob 作为网址变量 Runoob
然后在文档的结尾为变量赋值(网址)


5. Markdown 图片


  • Markdown 图片语法格式如下:
![alt 属性文本](图片地址)
![alt 属性文本](图片地址 "可选标题")
  • 效果如下所示:
    星空
    星空

6. Markdown 表格


表格基础

  • Markdown 制作表格使用 | 来分隔不同的单元格,使用 - 来分隔表头和其他行。语法格式如下:
| 表头 | 表头 |
| ---- | ---- |
| 单元格 | 单元格 |
| 单元格 | 单元格 |
  • 效果如下所示:
表头 表头
单元格 单元格
单元格 单元格

对齐方式

我们可以设置表格的对齐方式:

  • -: 设置内容和标题栏居右对齐。
  • :- 设置内容和标题栏居左对齐。
  • :-: 设置内容和标题栏居中对齐。

实例如下:

| 左对齐 | 右对齐 | 居中对齐 |
| :-----| ----: | :----: |
| 单元格 | 单元格 | 单元格 |
| 单元格 | 单元格 | 单元格 |
左对齐 右对齐 居中对齐
单元格 123123 单元格 123123 单元格 123123
单元格 单元格 单元格

7. Markdown 高级(待更新)