0
点赞
收藏
分享

微信扫一扫

Markdown 教程:这一篇博客就让你学会制作高逼格的文档

陆佃 2023-02-02 阅读 103


目录

​​Markdown 教程​​

​​Markdown 应用​​

​​编辑器​​

​​测试实例​​

​​Markdown 标题​​

​​使用 = 和 - 标记一级和二级标题​​

​​使用 # 号标记​​

​​Markdown 段落​​

​​字体​​

​​分隔线​​

​​删除线​​

​​下划线​​

​​脚注​​

​​Markdown 列表​​

​​列表嵌套​​

​​Markdown 区块​​

​​区块中使用列表​​

​​列表中使用区块​​

​​Markdown 代码​​

​​代码区块​​

​​Markdown 链接​​

​​高级链接​​

​​Markdown 图片​​

​​Markdown 表格​​

​​对齐方式​​

​​Markdown 高级技巧​​

​​支持的 HTML 元素​​

​​转义​​

Markdown 教程

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

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

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

Markdown 应用

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

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

编辑器

我将使用 Typora 编辑器来讲解 Markdown 的语法,Typora 支持 MacOS 、Windows、Linux 平台,且包含多种主题,编辑后直接渲染出效果。

支持导出HTML、PDF、Word、图片等多种类型文件。

测试实例

Mardown 编写 Hello World! 语法:

# Hello World!

将该代码格式粘贴到 Typora 效果如下:

Markdown 教程:这一篇博客就让你学会制作高逼格的文档_嵌套

Markdown 标题

Markdown 标题有两种格式。

使用 = 和 - 标记一级和二级标题

= 和 - 标记语法格式如下:

我展示的是一级标题
=================

我展示的是二级标题
-----------------

输出如下:

Markdown 教程:这一篇博客就让你学会制作高逼格的文档_Markdown_02

使用 # 号标记

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

# 1 一级标题
## 2 二级标题
### 3 三级标题
#### 4 四级标题
##### 5 五级标题
###### 6 六级标题

输出如下:

Markdown 教程:这一篇博客就让你学会制作高逼格的文档_Markdown_03

Markdown 段落

Markdown 段落没有特殊的格式,直接编写文字就好,段落的换行是使用两个以上空格加上回车

也可以在段落后面使用一个空行来表示重新开始一个段落。

字体

Markdown 可以使用以下几种字体:

*斜体*
_斜体_
**粗体**
__粗体__
***粗斜体***
___粗斜体___

输出如下:

Markdown 教程:这一篇博客就让你学会制作高逼格的文档_Markdown_04

分隔线

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

-------

- - -

********

* * * *

*****

输出如下:

Markdown 教程:这一篇博客就让你学会制作高逼格的文档_Markdown_05

删除线

如果段落上的文字要添加删除线,只需要在文字的两端加上两个波浪线 ~~ 即可,实例如下:

火影忍者
海贼王
~~火影忍者~~
~~海贼王~~

输出如下:

Markdown 教程:这一篇博客就让你学会制作高逼格的文档_嵌套_06

下划线

下划线可以通过 HTML 的 <u> 标签来实现:

<u>带下划线文本</u>

输出如下:

Markdown 教程:这一篇博客就让你学会制作高逼格的文档_Markdown_07

脚注

脚注是对文本的补充说明。

Markdown 脚注的格式如下:

[^要脚注的文本]

以下实例演示了脚注的用法:

创建脚注[^哔哩哔哩]

[^哔哩哔哩]:牛逼

 

输出如下:

Markdown 教程:这一篇博客就让你学会制作高逼格的文档_Markdown_08

Markdown 列表

Markdown 支持有序列表和无序列表。

无序列表使用星号(*)、加号(+)或是减号(-)作为列表标记:

* 第一
* 第二
* 第三

+ 第一
+ 第二
+ 第三

- 第一
- 第二
- 第三

输出如下:

Markdown 教程:这一篇博客就让你学会制作高逼格的文档_嵌套_09

 

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

1. 第一
2. 第二
3. 第三

输出如下:

Markdown 教程:这一篇博客就让你学会制作高逼格的文档_Markdown_10

列表嵌套

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

1. 第一项
- 第一项嵌套1
- 第一项嵌套2
2. 第二项
- 第二项嵌套1
- 第二项嵌套2

输出如下:

Markdown 教程:这一篇博客就让你学会制作高逼格的文档_Markdown_11

Markdown 区块

Markdown 区块引用是在段落开头使用 > 符号 ,然后后面紧跟一个空格符号:

> 哔哩哔哩
> 牛逼

输出如下:

Markdown 教程:这一篇博客就让你学会制作高逼格的文档_嵌套_12

另外区块是可以嵌套的,一个 > 符号是最外层,两个 > 符号是第一层嵌套,以此类推退:

> 中国
> >北京
> > > 海淀

输出如下:

Markdown 教程:这一篇博客就让你学会制作高逼格的文档_嵌套_13

区块中使用列表

区块中使用列表实例如下:

> 区块中显示列表
> 1. 第一项
> 2. 第二项
> + 第一项
> + 第二项
> + 第三项

输出如下:

Markdown 教程:这一篇博客就让你学会制作高逼格的文档_嵌套_14

列表中使用区块

如果要在列表项目内放进区块,那么就需要在 > 前添加四个空格的缩进。

区块中使用列表实例如下:

* 第一项
> 火影忍者
> 海贼王
* 第二项

输出如下:

Markdown 教程:这一篇博客就让你学会制作高逼格的文档_HTML_15

Markdown 代码

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

`print()`函数

输出如下:

Markdown 教程:这一篇博客就让你学会制作高逼格的文档_HTML_16

代码区块

代码区块使用 4 个空格或者一个制表符(Tab 键)

实例如下:

#include<stdio.h>

int main(){

printf("Hello World!\n");

return 0;
}

输出如下:

Markdown 教程:这一篇博客就让你学会制作高逼格的文档_嵌套_17

也可以用 ``` 包裹一段代码,并指定一种语言(也可以不指定):

```python3
import numpy as ny

num = 9
num_square_root = ny.sqrt(num)
print(num)
```

输出如下:

Markdown 教程:这一篇博客就让你学会制作高逼格的文档_HTML_18

Markdown 链接

链接使用方法如下:

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

如:

[哔哩哔哩](http://www.bilibili.com)
<http://www.bilibili.com>

输出如下:

Markdown 教程:这一篇博客就让你学会制作高逼格的文档_HTML_19

按住ctrl键,同时点击文字,可以跳转到哔哩哔哩。

高级链接

链接也可使用变量来代替,文档末尾附带变量地址:
这个链接用1作为网址变量:[bilibili][1]
这个链接用var作为网址变量:[百度][var]
然后在文档末尾为变量赋值(网址)

[1]: http://www.bilibili.com/
[var]: http://baidu.com/

输出如下:

Markdown 教程:这一篇博客就让你学会制作高逼格的文档_Markdown_20

Markdown 图片

Markdown 图片语法格式如下:

![alt 属性文本](图片地址)
![alt 属性文本](图片地址 "可选标题")

  • 开头一个感叹号 !
  • 接着一个方括号,里面放上图片的替代文字
  • 接着一个普通括号,里面放上图片的网址,最后还可以用引号包住并加上选择性的 'title' 属性的文字。

输入如下:

![bilibili 哔哩哔哩](C:\Users\Re:CREATORS\Pictures\壁纸\3.jpg)
![bilibili 哔哩哔哩](C:\Users\Re:CREATORS\Pictures\壁纸\3.jpg "哔哩哔哩")

输出如下:

Markdown 教程:这一篇博客就让你学会制作高逼格的文档_HTML_21

Markdown 还没有办法指定图片的高度与宽度,如果需要,可以使用普通的 <img> 标签:

<img src="C:\Users\Re:CREATORS\Pictures\壁纸\3.jpg" width="50%">

输出如下:

Markdown 教程:这一篇博客就让你学会制作高逼格的文档_HTML_22

Markdown 表格

Markdown 制作表格使用 | 来分隔不同的单元格,使用 - 来分隔表头和其他行。

语法格式如下:

| 表头 | 表头 |
| ---- | ---- |
| 单元格 | 单元格 |
| 单元格 | 单元格 |

输出如下:

Markdown 教程:这一篇博客就让你学会制作高逼格的文档_HTML_23

对齐方式

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

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

实例如下:

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

输出如下:

Markdown 教程:这一篇博客就让你学会制作高逼格的文档_HTML_24

Markdown 高级技巧

支持的 HTML 元素

不在 Markdown 涵盖范围之内的标签,都可以直接在文档里面用 HTML 撰写。

目前支持的 HTML 元素有:​​<kbd> <b> <i> <em> <sup> <sub> <br>​​等 ,如:

使用<kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>Del</kbd>重启电脑

输出如下:

Markdown 教程:这一篇博客就让你学会制作高逼格的文档_HTML_25

转义

Markdown 使用了很多特殊符号来表示特定的意义,如果需要显示特定的符号则需要使用转义字符,Markdown 使用反斜杠转义特殊字符:

**文本加粗**
\*\*正常显示星号\*\*

输出如下:

Markdown 教程:这一篇博客就让你学会制作高逼格的文档_HTML_26

Markdown 支持以下这些符号前面加上反斜杠来帮助插入普通的符号:

\   反斜线
` 反引号
* 星号
_ 下划线
{} 花括号
[] 方括号
() 小括号
# 井字号
+ 加号
- 减号
. 英文句点
! 感叹号

小结

## 二级标题(使用一个 # 到6个 # 表示从一级到六级标题)


段与段之间使用一个空行表示新段落的开始


*斜体*
**粗体**
***粗斜体***
_斜体_
__粗体__
___粗斜体___


三个以上的*或者-或者_建立分隔线


~~删除线~~


<u>下划线</u>


创建脚注[^哔哩哔哩]
[^哔哩哔哩]:牛逼


* 无序列表1
+ 无序列表2
- 无序列表3


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


1. 列表嵌套
- 第一项嵌套
- 第二项嵌套
2. 列表嵌套
- 第一项嵌套
- 第二项嵌套


> 区块哔哩哔哩
> 牛逼


> 区块嵌套
>> 哔哩哔哩
>>> 牛逼


> 区块中显示列表
> 1. 第一项
> 2. 第二项
> + 第一项
> + 第二项


* 列表中显示区块
> 火影忍者
> 海贼王


一个函数段落或片段 `print()` 哦


# 代码区块
#include<stdio.h>

int main(){
printf("Hello World!");
return 0;
}


```python3
# 用```包裹代码并且指定语言
print("Hello World!\n")
```


超链接
[链接名称](链接地址)
如:
[哔哩哔哩](http://www.bilibili.com)

或者
<http://www.bilibili.com>


图片
![可替代文本](图片地址 "可选可不选的图片标题")
如:
![哔哩哔哩](C:\Users\Re:CREATORS\Pictures\壁纸\1.jpg "bilibili")

或者直接使用HTML的<img>标签
<img src="C:\Users\Re:CREATORS\Pictures\壁纸\1.jpg" width=50%>


表格
|表头|表头|
|---|---|
|单元格|单元格|
|单元格|单元格|

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


支持的HTML元素
<kbd>键盘元素</kbd>
<b>粗体</b>
<i>斜体</i>
<em>强调</em>
x<sup>上标</sup>
x<sub>下标</sub>
<br /> 空行


转义字符
\*正常显示星号\*

举报

相关推荐

0 条评论