关于markdown:Markdown使用技巧

51次阅读

共计 4192 个字符,预计需要花费 11 分钟才能阅读完成。

简介

Markdown 是一种轻量级标记语言,它容许人们应用易读易写的纯文本格式编写文档。

Markdown 编写的文档能够导出 HTML、Word、图像、PDF、Epub 等多种格局的文档。

Markdown 编写的文档后缀为 .md, .markdown

原文:菜鸟教程

题目

应用 = 和 – 标记一级和二级题目

我展现的是一级题目
=================

我展现的是二级题目
-----------------

号标记

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

段落

段落的换行是应用两个以上空格加上回车

字体

* 斜体文本 *
_斜体文本_
** 粗体文本 **
__粗体文本__
*** 粗斜体文本 ***
___粗斜体文本___

分隔线

***
* * *
*****
- - -
----------

删除线

如果段落上的文字要增加删除线,只须要在文字的两端加上两个波浪线 ~~ 即可,实例如下:

RUNOOB.COM
GOOGLE.COM
~~BAIDU.COM~~

下划线

下划线能够通过 HTML 的 ** 标签来实现:

<u> 带下划线文本 </u>

脚注

脚注是对文本的补充阐明。

Markdown 脚注的格局如下:

[^ 要注明的文本]

列表

无序列表应用星号 (*)、加号(+) 或是减号 () 作为列表标记:

* 第一项
* 第二项
* 第三项

+ 第一项
+ 第二项
+ 第三项

- 第一项
- 第二项
- 第三项

有序列表应用数字并加上 . 号来示意,如:

1. 第一项
2. 第二项
3. 第三项

列表嵌套

列表嵌套只需在子列表中的选项增加四个空格即可:

1. 第一项:- 第一项嵌套的第一个元素
    - 第一项嵌套的第二个元素
2. 第二项:- 第二项嵌套的第一个元素
    - 第二项嵌套的第二个元素

区块

Markdown 区块援用是在段落结尾应用 > 符号,而后前面紧跟一个 空格 符号:

> 区块援用
> 菜鸟教程
> 学的不仅是技术更是幻想

另外区块是能够嵌套的,一个 > 符号是最外层,两个 > 符号是第一层嵌套,以此类推:

> 最外层
> > 第一层嵌套
> > > 第二层嵌套

区块中应用列表

区块中应用列表实例如下:

> 区块中应用列表
> 1. 第一项
> 2. 第二项
> + 第一项
> + 第二项
> + 第三项

列表中应用区块

如果要在列表我的项目内放进区块,那么就须要在 > 前增加四个空格的缩进。

区块中应用列表实例如下:

* 第一项
    > 菜鸟教程
    > 学的不仅是技术更是幻想
* 第二项

代码

如果是段落上的一个函数或片段的代码能够用反引号把它包起来(`),例如:

`printf()` 函数

代码区块

代码区块应用 4 个空格 或者一个 制表符(Tab 键)

你也能够用 ` 包裹一段代码,并指定一种语言(也能够不指定):

```javascript
$(document).ready(function () {alert('RUNOOB');
});
```

链接

链接应用办法如下:

[链接名称](链接地址)
或者
< 链接地址 >

例如:

这是一个链接 [菜鸟教程](https://www.runoob.com)

间接应用链接地址:

<https://www.runoob.com>

高级链接

咱们能够通过变量来设置一个链接,变量赋值在文档开端进行:

这个链接用 1 作为网址变量 [Google][1]
这个链接用 runoob 作为网址变量 [Runoob][runoob]
而后在文档的结尾为变量赋值(网址)[1]: http://www.google.com/
  [runoob]: http://www.runoob.com/

图片

Markdown 图片语法格局如下:

![alt 属性文本](图片地址)
![alt 属性文本](图片地址 "可选题目")
  • 结尾一个感叹号 !
  • 接着一个方括号,外面放上图片的代替文字
  • 接着一个一般括号,外面放上图片的网址,最初还能够用引号包住并加上选择性的 ‘title’ 属性的文字。

应用实例:

![RUNOOB 图标](http://static.runoob.com/images/runoob-logo.png)
![RUNOOB 图标](http://static.runoob.com/images/runoob-logo.png "RUNOOB")

当然,你也能够像网址那样对图片网址应用变量:

这个链接用 1 作为网址变量 [RUNOOB][1].
而后在文档的结尾为变量赋值(网址)[1]: http://static.runoob.com/images/runoob-logo.png

Markdown 还没有方法指定图片的高度与宽度,如果你需要的话,你能够应用一般的 <img> 标签。

<img src="http://static.runoob.com/images/runoob-logo.png" width="50%">

表格

Markdown 制作表格应用 | 来分隔不同的单元格,应用 来分隔表头和其余行。

语法格局如下:

|  表头   | 表头  |
|  ----  | ----  |
| 单元格  | 单元格 |
| 单元格  | 单元格 |

对齐形式

咱们能够设置表格的对齐形式:

  • -: 设置内容和标题栏居右对齐。
  • :- 设置内容和标题栏居左对齐。
  • :-: 设置内容和标题栏居中对齐。

实例如下:

| 左对齐 | 右对齐 | 居中对齐 |
| :-----| ----: | :----: |
| 单元格 | 单元格 | 单元格 |
| 单元格 | 单元格 | 单元格 |

高级技巧

反对的 HTML 元素

不在 Markdown 涵盖范畴之内的标签,都能够间接在文档外面用 HTML 撰写。

目前反对的 HTML 元素有: 等,如:

应用 <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>Del</kbd> 重启电脑

本义

Markdown 应用了很多特殊符号来示意特定的意义,如果须要显示特定的符号则须要应用转义字符,Markdown 应用反斜杠本义特殊字符:

** 文本加粗 ** 
\*\* 失常显示星号 \*\*

Markdown 反对以下这些符号后面加上反斜杠来帮忙插入一般的符号:

\   反斜线
`   反引号
*   星号
_   下划线
{}  花括号
[]  方括号
()  小括号
#   井字号
+   加号
-   减号
.   英文句点
!   感叹号

公式

当你须要在编辑器中插入数学公式时,能够应用两个美元符 $$ 包裹 TeX 或 LaTeX 格局的数学公式来实现。提交后,问答和文章页会依据须要加载 Mathjax 对数学公式进行渲染。如:

$$
\mathbf{V}_1 \times \mathbf{V}_2 =  \begin{vmatrix} 
\mathbf{i} & \mathbf{j} & \mathbf{k} \\
\frac{\partial X}{\partial u} &  \frac{\partial Y}{\partial u} & 0 \\
\frac{\partial X}{\partial v} &  \frac{\partial Y}{\partial v} & 0 \\
\end{vmatrix}
${$tep1}{\style{visibility:hidden}{(x+1)(x+1)}}
$$

ypora 画流程图、时序图(程序图)、甘特图

1、横向流程图源码格局:

```mermaid
graph LR
A[方形] -->B(圆角)
    B --> C{条件 a}
    C -->|a=1| D[后果 1]
    C -->|a=2| E[后果 2]
    F[横向流程图]
```

2、竖向流程图源码格局:

```mermaid
graph TD
A[方形] --> B(圆角)
    B --> C{条件 a}
    C --> |a=1| D[后果 1]
    C --> |a=2| E[后果 2]
    F[竖向流程图]
```

3、规范流程图源码格局:

```flow
st=>start: 开始框
op=>operation: 解决框
cond=>condition: 判断框(是或否?)
sub1=>subroutine: 子流程
io=>inputoutput: 输入输出框
e=>end: 完结框
st->op->cond
cond(yes)->io->e
cond(no)->sub1(right)->op
```

4、规范流程图源码格局(横向):

```flow
st=>start: 开始框
op=>operation: 解决框
cond=>condition: 判断框(是或否?)
sub1=>subroutine: 子流程
io=>inputoutput: 输入输出框
e=>end: 完结框
st(right)->op(right)->cond
cond(yes)->io(bottom)->e
cond(no)->sub1(right)->op
```

5、UML 时序图源码样例:

```sequence
对象 A -> 对象 B: 对象 B 你好吗?(申请)Note right of 对象 B: 对象 B 的形容
Note left of 对象 A: 对象 A 的形容(提醒)
对象 B --> 对象 A: 我很好(响应)
对象 A -> 对象 B: 你真的好吗?```

6、UML 时序图源码简单样例:

```sequence
Title: 题目:简单应用
对象 A -> 对象 B: 对象 B 你好吗?(申请)Note right of 对象 B: 对象 B 的形容
Note left of 对象 A: 对象 A 的形容(提醒)
对象 B --> 对象 A: 我很好(响应)
对象 B -> 小三: 你好吗
小三 -->> 对象 A: 对象 B 找我了
对象 A -> 对象 B: 你真的好吗?Note over 小三, 对象 B: 咱们是敌人
participant C
Note right of C: 没人陪我玩
```

7、UML 规范时序图样例:

```mermaid
%% 时序图例子,-> 直线,--> 虚线,->> 实线箭头
  sequenceDiagram
    participant 张三
    participant 李四
    张三 -> 王五: 王五你好吗?loop 健康检查
        王五 -> 王五: 与疾病战斗
    end
    Note right of 王五: 正当 食物 <br/> 看医生...
    李四 -->> 张三: 很好!
    王五 -> 李四: 你怎么样?
    李四 --> 王五: 很好!
```

8、甘特图样例:

```mermaid
%% 语法示例
        gantt
        dateFormat  YYYY-MM-DD
        title 软件开发甘特图
        section 设计
        需要                      :done,    des1, 2014-01-06,2014-01-08
        原型                      :active,  des2, 2014-01-09, 3d
        UI 设计                     :         des3, after des2, 5d
    将来工作                     :         des4, after des3, 5d
        section 开发
        学习筹备了解需要                      :crit, done, 2014-01-06,24h
        设计框架                             :crit, done, after des2, 2d
        开发                                 :crit, active, 3d
        将来工作                              :crit, 5d
        耍                                   :2d
        section 测试
        功能测试                              :active, a1, after des3, 3d
        压力测试                               :after a1  , 20h
        测试报告                               : 48h
```

正文完
 0