美文网首页
Markdown使用方式

Markdown使用方式

作者: 曾經丶記憶的風景 | 来源:发表于2019-04-28 11:31 被阅读0次

对于一个开发人员来说,必要的文档说明是必不可少的,好的文档说明可以让人快速了解到开发项目的信息,以便于团队协作开发。因而对于写文档,选择Markdown格式文件来说明,则是再好不过的。

而写这份文档,也是因为自己经常忘记Markdown的部分使用方式,所以就自己也总结一下,避免每次使用起来都度娘Google

选择Markdown原因: 易读易写


一、标题

H1-H6标题是用#来标识,顺序递增。(备注:二级标题会自带分割线)

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

另外,H1和H2还能用一下方式显示:

一级标题
===

二级标题
___

二、文本强调

*斜体* or _斜体_
**加粗** or __加粗__
***粗斜体*** or ___粗斜体___

注意:如果在文本中,* 和 _ 两边都有空白的话,就会被当成普通的符号:这是一段* 强调 *文本说明。

如果要在文字前后插入普通的星号或底线,可以用反斜线(转义符):\*这是一段强调文本说明\*

三、列表

无序列表使用 *、+、- 作为列表标记。

* 列表项
* 列表项
* 列表项

+ 列表项
+ 列表项
+ 列表项

- 列表项
- 列表项
- 列表项

有序列表使用数字接着一个英文句点标记。

1. 列表项
2. 列表项
3. 列表项

1. 列表项
- 列表项
- 列表项

有时可能会出现这样情况,首行内容一日期或数字开头:2013. 业绩表。为了避免被转化成有序列表,我们可以在“.”前加上反斜杠(转义符):2013\. 业绩表。


三、引用

在Markdown中,只需要在你希望应用的文字前面加上>就可以了

> 你好

你好


四、代码区块

在Markdown中建立代码区块很简单,只要简单地缩进4个空格或是1个制表符就可以了。

这是一个普通的段落。

    这是一个代码区块(前面有4个空格)。

单行代码加上反引号(`)即可

\`这里是一段单行代码块\`

块级代码加上3个反引号(`)或波浪(~),有「闭合」

\`\`\`
这里是块级代码(这里展示,加上了转义符,否则会被识别为两个代码块)
\`\`\`

~~~
代码块
~~~

五、分割线

在一行中可以使用3个以上的 *、-、_ 来建立一个分割线,行内不能有其他的东西。也可以在星号或者减号中间插入空格

***
* * *
---
- - - 
___________

六、区段元素

链接:Markdown支持两种形式链接语法:行内式参考式

不管是以哪种形式,链接文字都是用[方括号]标记。

行内式只要在方括号后面紧接着圆括号并插入链接即可。

比如:点击蓝色文字就会跳转到百度地址。

点击[蓝色文字](https://www.baidu.com/)就会跳转到百度地址。

如果你想在链接上加上 title 文字,只要在网址后面
跟上用双引号包起来的文字即可。

点击[蓝色文字](https://www.baidu.com/ "百度")就会跳转到
百度地址。

参考式在链接文字的扩哦好后面再接上另一个方括号,而在第二个方括号里面填入用以辨识链接的标记。

点击[百度][id]即可跳转

也可以选择性的在两个方括号中间加上空格
点击[百度] [id] 即可跳转

然后,在文件任意处把这个标记的链接内容定义出来:

\'[id]: https://www.baidu.com/ "百度地址"\'

注意:链接辨识标签可以有字母、数字、空白、标点符号,但是不区分大小写,因此下面两个链接是一样的:

[link][a]

[link][A]


七、图片

图片链接如下:

  • 一个感叹号(!)
  • 接着一个方括号,里面放上图片的代替文字
  • 接着一个圆括号,里面放上图片的地址,最后还可以用引号包住并加上选择性的 ‘title’ 文字
![images](图片的地址)
images

图片的参考式:

![images][id]

\'[id]: 图片的地址 "Optional title"\'

八、表格

| 默认格式 | 左对齐 | 居中 | 右对齐 |
| --- | :--- | :---: | ---: |
| 默认表格内容 | 左对齐表格内容 | 居中对齐表格内容 | 右对齐表格内容 |
| 默认表格内容 | 左对齐表格内容 | 居中对齐表格内容 | 右对齐表格内容 |
默认格式 左对齐 居中 右对齐
默认表格内容 左对齐表格内容 居中对齐表格内容 右对齐表格内容
默认表格内容 左对齐表格内容 居中对齐表格内容 右对齐表格内容

相关文章

  • Markdown使用方式

    第一层标题 第二层标题 第三层标题 第四层标题 第五层标题 第六层标题 文字前面加点 1.文字前面加数字 文本加链...

  • Markdown使用方式

    对于一个开发人员来说,必要的文档说明是必不可少的,好的文档说明可以让人快速了解到开发项目的信息,以便于团队协作开发...

  • Markdown插入图片

    markdown在文字中嵌入图片,使用如下方式

  • Markdown使用table标签创建表格的问题

    使用Markdown写东西有时需要插入表格,方式有两种: 1.使用Markdown的表格语法 2.使用html的 ...

  • Markdown的简单实例

    本文简单的记录使用markdown的方式,完成一篇博客必备的基础语法。 1. 导航: markdown代码: 显示...

  • Markdown入门

    书写设置请查看 : MarkDown书写设置 一直觉得简书的编辑方式很好,但是使用的是Markdown,对于小白的...

  • MarkDown基本用法

    说明 MarkDown在很多地方都是一种比较常见的编辑方式,当前许多网站也都广泛使用 Markdown 来撰写帮助...

  • 第一次尝试使用markdown写文档

    认识markdown已经有一段时间了,昨天需要使用写一个测试报告,终于下定决心使用markdown这个方式来写。我...

  • 生信星球学习小组——Day1

    学习平台的使用 (1)Markdown 的使用方式 重点内容:标题、粗体、引用段落、代码块print() (2)简...

  • 我与markdown的邂逅

    初次见到你markdown markdown中对于标题的使用方式都是用#来表示的,最大号的标题就是一个#,依次是两...

网友评论

      本文标题:Markdown使用方式

      本文链接:https://www.haomeiwen.com/subject/aocdnqtx.html