如何写Markdown格式文档
2024-09-05 12:42:09
Markdown
- Markdown是一种轻量级标记语言,创始人为约翰·格鲁伯。它允许人们使用易读易写的纯文本格式编写文档,然后转换成有效的XHTML(或者HTML)文档。这种语言吸收了很多在电子邮件中已有的纯文本标记的特性。—— 维基百科
- 由于Markdown的轻量化、易读易写特性,并且对于图片,图表、数学式都有支持,目前许多网站都广泛使用Markdown来撰写帮助文档或是用于论坛上发表消息。如GitHub、Reddit、Diaspora、Stack Exchange、OpenStreetMap 、SourceForge、简书等,甚至还能被使用来撰写电子书。—— 维基百科
本文完全采用Markdown编写->完整文本
注:所有标记后都要跟上空格
锚点跳转至 十一、锚点
一、标题
- Markdown的标题和html的
<h1>
标签非常相识,使用#来表示标题,一个#表示一级标题,两个#表示二级标题,以此类推,直至六级标题。
示例:
# 一级标题
## 二级标题
### 三级标题
#### 四级标题
##### 五级标题
###### 六级标题
一级标题
二级标题
三级标题
四级标题
五级标题
六级标题
二、列表
- 列表分为有序列表和无序列表。
注:符号和内容间一定要有空格
- 有序列表
使用
1.
2.
,在数字后面添加.
1. 有序列1
2. 有序列2
3. 有序列3
- 无序列表
使用
*
-
+
均可(建议使用*
)。
* 无序列表
- 列表嵌套
在使用有序、无序列表后,下一行添加三个空格
1. 一级1
1. 二级1
2. 二级2
2. 一级2
- 一级1
- 二级1
- 二级2
- 一级2
三、表格
- Markdown中使用表格略微麻烦。
- 第一行作为表头,使用
|
分割列。 - 第二行作为分割表头和内容行,也采用
|
分割列,使用-
(一个即可,可以采用多个便于查看)分割行,默认是居左,采用:
进行调整布局。 - 第三行开始才是表格内容,同样使用
|
分割列。
示例:
|这是一个比较长的表头|这是一个比较长的表头|这是一个比较长的表头|这是一个比较长的表头|
|-------|:------|------:|:-------:|
|默认居左|居左`:-`|居右`-:`|居中`:-:`|
|默认居左|居左`:-`|居右`-:`|居中`:-:`|
这是一个比较长的表头 | 这是一个比较长的表头 | 这是一个比较长的表头 | 这是一个比较长的表头 |
---|---|---|---|
默认居左 | 居左:- |
居右-: |
居中:-: |
默认居左 | 居左:- |
居右-: |
居中:-: |
四、字体
- Markdown默认可以对字体进行 加粗、斜体、斜体加粗、删除线 操作。
**加粗**
*斜体*
***斜体加粗***
~~删除线~~
文字居中:
<center>SILVER</center>
字体大小
size为1:
<font size="1">size为1</font>
size为2:
<font size="2">size为2</font>
size为3:
<font size="3">size为3</font>
五、引用
- 使用
>
可以进行引用,使用多个>>
可以进行嵌套引动。
> 引用内容
>> 引用内容
>>> 引用内容
>>>> 引用内容
引用内容
引用内容
引用内容
引用内容
六、超链接
- 使用
[地址名称](地址)
定义一个超链接,默认在新标签页打开。
[如何写Markdown格式文档](https://www.cnblogs.com/falsehero/p/14186148.html)
七、分割线
- 使用三个或三个以上
-
、*
进行添加分割线
***
---
- 分割线
八、图片
- 使用
![图片下方文字](图片地址 "鼠标放在图片上需要显示的内容")
![百度图片](https://ss2.bdstatic.com/70cFvnSh_Q1YnxGkpoWK1HF6hhy/it/u=2785679772,3199433352&fm=26&gp=0.jpg "来自百度图片")
或使用<img src="xxxxx" alt="图片" width="820" height="402" />
九、代码
- 单行代码使用单个反引号包裹,多行代码使用三个反引号包裹,在反引号后可添加该代码块是属于哪种语言。
示例(单行代码):
`int c = 1 + 1`
int c = 1 + 1
示例(多行代码):
```java
int a = 0;
int b = 0;
int c = a + b;
> **注:**此处使用了两层代码标记,所以在结束处也添加了语言标记,正常使用下结束可以忽略语言标记。
```java
int a = 0;
int b = 0;
int c = a + b;
十、邮箱
- 使用
<example@example.com>
添加邮箱显示。
<example@example.com>
十一、锚点
- 使用
#
标题标记当前位置作为锚点,在其他地方使用[说明](#id)
进行跳转。
可以使用html的
<span id ="id"></span>
定义一个锚点,然后使用[说明](#id)
进行跳转。
#一、标题
十二、html
- 在Markdown中可以使用html语法。
示例:
<p style="color: aqua"></p>
简单使用html语法
结束
- 以上就是关于Makerdown的简单使用,如有变动会持续更新。
注:文章转载至https://www.cnblogs.com/falsehero/p/14186148.html 原版文章内容丰富,故借鉴
最新文章
- 【A Global Line Matching Algorithm for 2D Laser Scan Matching in Regular Environment】
- 青瓷引擎使用心得——修改引擎的loading界面
- 新的Visual C++代码优化器
- Android 使用Okhttp/Retrofit持久化cookie的简便方式
- HDU 5464 ( Clarke and problem ) (dp)
- poj2488 A Knight&#39;s Journey
- wxWidgets+wxSmith版电子词典
- [妙味JS基础]第四课:JS数据类型、类型转换
- Struts2--DomainModel接收参数---使用广泛!!!
- RedisPool操作Redis,工具类实例
- css3 背景色 实现边框渐变运动动画
- 041 SparkSql的回顾与复习
- Java第三方支付接入案例(支付宝)
- Ehcache配置参数示例
- 【译】第45节---EF6-索引属性
- apiCloud 三方分享,微信好友分享,微信朋友圈分享,QQ分享,微博分享
- 如何实时查看Linux下日志
- Tidb数据库报错:Transaction too large
- .net 调用API并解析Json数据方法
- 用pyqt5做一个能python程序能插入图片的ide