如何写Markdown格式文档
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)
七、分割线
- 使用三个或三个以上
-、*进行添加分割线
***
---
- 分割线
八、图片
- 使用


或使用<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 原版文章内容丰富,故借鉴
如何写Markdown格式文档的更多相关文章
- 使用Apache POI导出Excel小结--导出XLS格式文档
使用Apache POI导出Excel小结 关于使用Apache POI导出Excel我大概会分三篇文章去写 使用Apache POI导出Excel小结--导出XLS格式文档 使用Apache POI ...
- Swagger解决你手写API接口文档的痛
首先,老规矩,我们在接触新事物的时候, 要对之前学习和了解过的东西做一个总结. 01 痛 苦 不做.不行 之前,前后端分离的系统由前端和后端不同的编写,我们苦逼的后端工程师会把自己已经写完的A ...
- Ubuntu 14 如何打开 .chm格式文档?
好多手册是.chm格式,Ubuntu是需要安装第三方软件才能打开.chm格式文档,操作方式如下: 到“软件中心” -> 搜索“xchm”,并安装 -> 右键某个.chm文档,选择“属性” ...
- CEBX格式的文档如何转换为PDF格式文档、DOCX文档?
方正阿帕比CEBX格式的文档如何转换为PDF格式文档.DOCX文档? 简介: PDF.Doc.Docx格式的文档使用的非常普遍,金山WPS可以直接打开PDF和Doc.Docx文档,使用也很方便. CE ...
- 写到 HTML 文档
<!DOCTYPE html><html><head><meta http-equiv="Content-Type" content=&q ...
- MARKDOWN使用文档
ISSUE引用 引用当前项目内的ISSUE #1 markdown写法 #1 引用当前命名空间下的其他项目内的ISSUE projectname#1 sofa_ta#1 markdown写法 sofa ...
- 如何写好技术文档——来自Google十多年的文档经验
本文大部分内容翻译总结自<Software Engineering at Google> 第10章节 Documentation. 另外,该书电子版近日已经可以免费下载了 https:// ...
- 如何使用Markdown 编写文档
Markdown 是一种轻量级标记语言,用来编写文本文档,一般后缀名为.md.该语言在 2004 由约翰·格鲁伯(John Gruber)创建. 由于Markdown 语法简单,易读易写,变得越来越通 ...
- 基于 vite2 + Vue3 写一个在线帮助文档工具
提起帮助文档,想必大家都会想到 VuePress等,我也体验了一下,但是感觉和我的思路不太一样,我希望的是那种可以直接在线编辑文档,然后无需编译就可以直接发布的方式,另外可以在线写(修改)代码并且运行 ...
随机推荐
- TensorFlow 卷积神经网络实用指南 | iBooker·ApacheCN
原文:Hands-On Convolutional Neural Networks with TensorFlow 协议:CC BY-NC-SA 4.0 自豪地采用谷歌翻译 不要担心自己的形象,只关心 ...
- JVM学习二:JVM之GC算法和种类
我们前面说到了JVM的常用的配置参数,其中就涉及了GC相关的知识,趁热打铁,我们今天就学习下GC的算法有哪些,种类又有哪些,让我们进一步的认识GC这个神奇的东西,帮助我们解决了C 一直挺头疼的内存回收 ...
- 清除git中缓存的凭证(用户名及密码)
今天刚接触Git,还有Gitstack,然后在克隆Gitstack服务器上的仓库时出现了一直用户身份识别失败问题,找了一些大佬的文章才知道原因在于密码输入错误过多.那么如何重新输入呢? 需要清空本地的 ...
- element select失效问题 , vue刷新的两种方式
changeSelect: function () { this.$forceUpdate(); }, 编辑一条记录,给select 赋值后就不动了, 原因是复制后组件需要刷新一下, 不然不能触发事件 ...
- Linux常用命令,面试常考
Linux常用命令 网络工具 查看监听端口的进程: lsof -i :8080 或者 netstat -tupln|grep 8080 复制 软连接创建 ln -s 源文件 目标文件
- 红色小圆点+数字的badge自定义小方法 by Nicky.Tsui
效果如图. 实现方法比较简单,在view上增加一个label label设置: 1 badgeLabel = [[UILabel alloc]initWithFrame:CGRectMake(CGRe ...
- Spark算子 - aggregateByKey
释义 aggregateByKey逻辑类似 aggregate,但 aggregateByKey针对的是PairRDD,即键值对 RDD,所以返回结果也是 PairRDD,结果形式为:(各个Key, ...
- Windows安装PostgreSQL解压版
PostgreSQL下载地址:https://www.enterprisedb.com/downloads/postgres-postgresql-downloads windows版,务必装在C盘! ...
- SYSTEM表空间满,解决方法
SYSTEM表空间是Oracle创建数据库时候自动创建的,每个Oracle数据库都会有SYSTEM表空间,而且SYSTEM表空间总是要保持在联机模式下,因为其包含了数据库运行所要求的基本信息,如:数据 ...
- drop、truncate、delete的区别
(1)DELETE语句执行删除的过程是每次从表中删除一行,并且同时将该行的删除操作作为事务记录在日志中保存以便进行进行回滚操作. TRUNCATE TABLE 则一次性地从表中删除所有的数据并不把单独 ...