如何写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等,我也体验了一下,但是感觉和我的思路不太一样,我希望的是那种可以直接在线编辑文档,然后无需编译就可以直接发布的方式,另外可以在线写(修改)代码并且运行 ...
随机推荐
- 使用require.context实现前端工程自动化
require.context是什么 一个webpack的api,通过执行require.context函数获取一个特定的上下文,主要用来实现自动化导入模块,在前端工程中,如果遇到从一个文件夹引入很多 ...
- 浅谈VPC (转)
来源于知乎:https://zhuanlan.zhihu.com/p/33658624 VPC全称是Virtual Private Cloud,翻译成中文是虚拟私有云.但是在有些场合也被翻译成私有网络 ...
- k8s之资源限制以及探针检查
k8s之资源限制以及探针检查 一.资源限制 1. 资源限制的使用 当定义Pod时可以选择性地为每个容器设定所需要的资源数量.最常见的可设定资源是CPU和内存大小,以及其他类型的资源. 2. reuqe ...
- Centos8安装virtualbox
一.执行以下命令并启用 VirtualBox 和 EPEL 包仓库 dnf config-manager --add-repo=https://download.virtualbox.org/virt ...
- 一个实用批处理指令制作过程分享:Perforce更新完后打开VisualStudio再编译
需求来源 笔者从事Unreal游戏客户端工作,使用VisualStudio开发,然后经常干一个事:就是使用Perforce(或svn)拉取最新代码,(一些时间后)拉取完之后然后打开 项目.sln,即V ...
- Solution Set -「LOCAL」冲刺省选 Round XXIV
\(\mathscr{Summary}\) 名副其实的 trash round,希望以后没有了. A 题算好,确实一个比较关键的简化状态的点没想到,所以只拿了暴力(不考虑 \(\mathcal ...
- Note -「单位根反演」学习笔记
\(\mathcal{Preface}\) 单位根反演,顾名思义就是用单位根变换一类式子的形式.有关单位根的基本概念可见我的这篇博客. \(\mathcal{Formula}\) 单位根反演的 ...
- 前端提交数据到node的N种方式
写在前面 本篇介绍了前端提交数据给node的几种处理方式,从最基本的get和post请求,到图片上传,再到分块上传,由浅入深. GET请求 经典的get提交数据,参数通过URL传递给node,node ...
- SQLMAP配置洋葱路由
[笔者目前使用的系统是kali渗透系统] =================================================================== 首先下载tor apt ...
- Oracle的常用命令和表空间
删除用户和表空间 ## 删除用户 drop user userName cascade; ## 如果用户无法删除,并报错: ## ERROR at line 1: ## ORA-01940: cann ...