Markdown

  • Markdown是一种轻量级标记语言,创始人为约翰·格鲁伯。它允许人们使用易读易写的纯文本格式编写文档,然后转换成有效的XHTML(或者HTML)文档。这种语言吸收了很多在电子邮件中已有的纯文本标记的特性。—— 维基百科
  • 由于Markdown的轻量化、易读易写特性,并且对于图片,图表、数学式都有支持,目前许多网站都广泛使用Markdown来撰写帮助文档或是用于论坛上发表消息。如GitHub、Reddit、Diaspora、Stack Exchange、OpenStreetMap 、SourceForge、简书等,甚至还能被使用来撰写电子书。—— 维基百科

本文完全采用Markdown编写->完整文本

注:所有标记后都要跟上空格

锚点跳转至 十一、锚点

一、标题

  • Markdown的标题和html的<h1>标签非常相识,使用#来表示标题,一个#表示一级标题,两个#表示二级标题,以此类推,直至六级标题。

示例:

# 一级标题
## 二级标题
### 三级标题
#### 四级标题
##### 五级标题
###### 六级标题

一级标题

二级标题

三级标题

四级标题

五级标题
六级标题

二、列表

  • 列表分为有序列表和无序列表。

    注:符号和内容间一定要有空格
  1. 有序列表

使用 1. 2.,在数字后面添加.

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

使用* - +均可(建议使用*)。

* 无序列表
  1. 列表嵌套

在使用有序、无序列表后,下一行添加三个空格

1. 一级1
1. 二级1
2. 二级2
2. 一级2
  1. 一级1

    1. 二级1
    2. 二级2
  2. 一级2

三、表格

  • Markdown中使用表格略微麻烦。
  1. 第一行作为表头,使用|分割列。
  2. 第二行作为分割表头和内容行,也采用|分割列,使用-(一个即可,可以采用多个便于查看)分割行,默认是居左,采用:进行调整布局。
  3. 第三行开始才是表格内容,同样使用|分割列。

示例:

|这是一个比较长的表头|这是一个比较长的表头|这是一个比较长的表头|这是一个比较长的表头|
|-------|:------|------:|:-------:|
|默认居左|居左`:-`|居右`-:`|居中`:-:`|
|默认居左|居左`:-`|居右`-:`|居中`:-:`|
这是一个比较长的表头 这是一个比较长的表头 这是一个比较长的表头 这是一个比较长的表头
默认居左 居左:- 居右-: 居中:-:
默认居左 居左:- 居右-: 居中:-:

四、字体

  • 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)

如何写Markdown格式文档

七、分割线

  • 使用三个或三个以上-、*进行添加分割线
***
---

  • 分割线

八、图片

  • 使用![图片下方文字](图片地址 "鼠标放在图片上需要显示的内容")
![百度图片](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>

邮箱:xxxx@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格式文档的更多相关文章

  1. 使用Apache POI导出Excel小结--导出XLS格式文档

    使用Apache POI导出Excel小结 关于使用Apache POI导出Excel我大概会分三篇文章去写 使用Apache POI导出Excel小结--导出XLS格式文档 使用Apache POI ...

  2. Swagger解决你手写API接口文档的痛

    首先,老规矩,我们在接触新事物的时候, 要对之前学习和了解过的东西做一个总结. 01 痛     苦 不做.不行 之前,前后端分离的系统由前端和后端不同的编写,我们苦逼的后端工程师会把自己已经写完的A ...

  3. Ubuntu 14 如何打开 .chm格式文档?

    好多手册是.chm格式,Ubuntu是需要安装第三方软件才能打开.chm格式文档,操作方式如下: 到“软件中心” -> 搜索“xchm”,并安装 -> 右键某个.chm文档,选择“属性” ...

  4. CEBX格式的文档如何转换为PDF格式文档、DOCX文档?

    方正阿帕比CEBX格式的文档如何转换为PDF格式文档.DOCX文档? 简介: PDF.Doc.Docx格式的文档使用的非常普遍,金山WPS可以直接打开PDF和Doc.Docx文档,使用也很方便. CE ...

  5. 写到 HTML 文档

    <!DOCTYPE html><html><head><meta http-equiv="Content-Type" content=&q ...

  6. MARKDOWN使用文档

    ISSUE引用 引用当前项目内的ISSUE #1 markdown写法 #1 引用当前命名空间下的其他项目内的ISSUE projectname#1 sofa_ta#1 markdown写法 sofa ...

  7. 如何写好技术文档——来自Google十多年的文档经验

    本文大部分内容翻译总结自<Software Engineering at Google> 第10章节 Documentation. 另外,该书电子版近日已经可以免费下载了 https:// ...

  8. 如何使用Markdown 编写文档

    Markdown 是一种轻量级标记语言,用来编写文本文档,一般后缀名为.md.该语言在 2004 由约翰·格鲁伯(John Gruber)创建. 由于Markdown 语法简单,易读易写,变得越来越通 ...

  9. 基于 vite2 + Vue3 写一个在线帮助文档工具

    提起帮助文档,想必大家都会想到 VuePress等,我也体验了一下,但是感觉和我的思路不太一样,我希望的是那种可以直接在线编辑文档,然后无需编译就可以直接发布的方式,另外可以在线写(修改)代码并且运行 ...

随机推荐

  1. AndroidStudio项目提交到github最详细步骤【转】

    感谢大佬:https://www.cnblogs.com/imqsl/p/6763133.html 在使用studio开发的项目过程中有时候我们想将项目发布到github上,以前都是用一种比较麻烦的方 ...

  2. Mybatis foreach的用法

    本文援引:https://www.cnblogs.com/fnlingnzb-learner/p/10566452.html 在做mybatis的mapper.xml文件的时候,我们时常用到这样的情况 ...

  3. [转载] IOS 获取网络图片的大小 改变 图片色值 灰度什么的方法集合

    IOS 获取网络图片的大小 改变 图片色值 灰度什么的方法集合

  4. DbUnit入门实战

    原文地址: http://yangzb.iteye.com/blog/947292 相信做过单元测试的人都会对JUnit 非常的熟悉了, 今天要介绍的DbUnit(http://dbunit.sour ...

  5. memcache启动多个服务

    windows 7 64bit 环境下安装memcached 1.下载后解压到D:\memcached(下载地址:memcached-win64下载地址) 2.安装到windows服务,打开cmd命令 ...

  6. 计算机的网络参考模型与5G协议

    计算机的网络参考模型与5G协议    1 分层思想 2  OSI参考模型 3  TCP/IP 协议族的组成 4  数据的封装与解封 5 层间通讯过程 6  空口协议 1.喝可乐的人不一定知道其生产的过 ...

  7. MySQL语法命令之约束篇

    文章目录 1.约束概述 1.1约束的分类 1.2添加约束 2.查看表中的约束 3. `not null` 非空约束 3.1 在 `create table` 时创建 3.2 在`alter table ...

  8. 谷粒商城Day1

    环境搭建 安装JDK1.8: 1 下载并解压jdk1.8 tar -zxvf jdk-8u281-linux-x64.tar.gz(检查本机有没有jdk有的话卸载掉.安装上自己的jdk) 2 配上环境 ...

  9. opencv笔记-GFTTDetector

    在 "光流跟踪" 中,使用了 Harris 角点作为 LK 光流跟踪输入点.角点定义为在两个方向上均有较大梯度变化的小区域,使用自相关函数描述. 自相关函数为为图像平移前后某一个区 ...

  10. world.construct(me);

    目录 0 引言 0.1 所谓构造题 0.2 重点是动机 (motivation) 1 实践出真知 1.1 「CSP-S 2021」「洛谷 P7915」回文 1.1.1 题目大意 1.1.2 解题过程 ...