欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页

轻松上手Markdown

程序员文章站 2022-04-21 15:00:07
...

一、简介

  1. Markdown 是一种轻量级标记语言,它允许人们使用易读易写的纯文本格式编写文档。
  2. Markdown 语言在 2004 由约翰·格鲁伯(英语:John Gruber)创建。
  3. Markdown 编写的文档可以导出 HTML 、Word、图像、PDF、Epub 等多种格式的文档。
  4. Markdown 编写的文档后缀为 .md, .markdown。

二、应用

  1. Markdown 能被使用来撰写电子书,如:Gitbook。
  2. 当前许多网站都广泛使用 Markdown 来撰写帮助文档或是用于论坛上发表消息。例如:GitHub、简书、reddit、Diaspora、Stack Exchange、OpenStreetMap 、SourceForge等。

三、编辑器

本人使用 Typora 编辑器来讲解 Markdown 的语法,Typora 支持 MacOS 、Windows、Linux 平台,且包含多种主题,编辑后直接渲染出效果。支持导出HTML、PDF、Word、图片等多种类型文件。


四、基础语法

包括:标题、段落、字体、分割性、删除线、下划线、列表、区块、代码、链接、图片和表格等。

1.标题

在想要设置为标题的文字前面加#来表示。一个 # 是一级标题,二个 # 是二级标题,以此类推。支持六级标题。

(注:标准语法一般在#后跟个空格再写文字。)

示例:

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

效果如下:

轻松上手Markdown

2.段落

段落的换行是使用两个以上空格加上回车。当然也可以在段落后面使用一个空行来表示重新开始一个段落。

示例:

段落一   (两空格及以上)  
段落二

段落三

段落四

效果如下:

轻松上手Markdown

3.字体

Markdown 可以使用以下几种字体:

  • 斜体:要倾斜的文字左右分别用一个 * 号或一个 _ 号包起来。
  • 粗体:要加粗的文字左右分别用两个 * 号或两个 _ 号包起来。
  • 粗斜体:要倾斜和加粗的文字左右分别用三个 * 号或三个 _ 号包起来。

示例:

*斜体文本*
_斜体文本_

**粗体文本**
__粗体文本__

***粗斜体文本***
___粗斜体文本___

效果如下:

轻松上手Markdown

4.分隔线

可以在一行中用三个及以上的星号、减号、底线来建立一个分隔线,行内不能有其他东西。也可以在星号或是减号中间插入空格效果都一样

示例:

***
* * *
*****
_ _ _

效果如下:

轻松上手Markdown

5.删除线

如果段落上的文字要添加删除线,只需要在文字的两端加上两个波浪线 ~~ 即可。

示例:

~~删除线~~

效果如下:

轻松上手Markdown

6.下划线

下划线可以通过 HTML 的 <u> 标签来实现:

示例:

<u>下划线</u>

效果如下:

轻松上手Markdown

7.列表

Markdown 支持无序列表和有序列表

a.无序列表使用星号(*)、加号(+)或是减号(-)作为列表标记。(注:中间有空格)

示例:

* 第一项
* 第二项
* 第三项
+ 第四项
+ 第五项
+ 第六项
- 第七项
- 第八项
- 第九项

效果如下:

轻松上手Markdown

b.有序列表使用数字并加上 . 号来表示。(注:中间有空格)

示例:

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

效果如下:

轻松上手Markdown

8.区块

Markdown 区块引用是在段落开头使用 > 符号。

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

示例:

>Markdown
>>菜鸟教程  
>>>区块引用
>>>>学的不仅是技术更是梦想

效果如下:

轻松上手Markdown

(注:区块中可使用列表,列表中也可使用区块。)

9.代码

a.单行代码:代码之间分别用一个反引号 ` 包起来。

b.代码块:使用 4 个空格或者一个制表符(Tab 键),或用 ``` 包裹一段代码,并指定一种语言(也可以不指定)。

示例:

Inline `code`

Indented code

    // Some comments
    line 1 of code
    line 2 of code
    line 3 of code


Block code "fences"

```
Sample text here...
```

Syntax highlighting

``` js
var foo = function (bar) {
  return bar++;
};

console.log(foo(5));
```

效果如下:

轻松上手Markdown

10.链接

使用方法如下:

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

示例:

[CSDN](https://www.csdn.net/)

(https://www.csdn.net/)

效果如下:

轻松上手Markdown

(注:也可以用html语言的a标签代替。)

<a href="超链接地址" target="_blank">超链接名</a>

示例:
<a href="https://blog.csdn.net/weixin_40431584" target="_blank">菜鸟之志</a>

高级链接

示例:

链接也可以用变量来代替,文档末尾附带变量地址:
这个链接用 1 作为网址变量 [CSDN][1],
这个链接用 csdn作为网址变量 [CSDN][csdn],
然后在文档的结尾为变量赋值(网址).

  [1]: https://www.csdn.net/
  [csdn]: https://www.csdn.net/

效果如下:

轻松上手Markdown

11.图片

Markdown 图片语法格式如下:

![alt 属性文本](图片地址)
![alt 属性文本](图片地址 "可选标题")

(注:图片alt就是显示在图片下面的文字,相当于对图片内容的解释。图片title是图片的标题,当鼠标移到图片上时显示的内容。title可加可不加。)

示例:

![CSDN](https://csdnimg.cn/cdn/content-toolbar/csdn-logo_.png?v=20190924.1)

![CSDN](https://csdnimg.cn/cdn/content-toolbar/csdn-logo_.png?v=20190924.1 "CSDN")

效果如下:

轻松上手Markdown

(注:也可以像网址那样对图片网址使用变量)

12.表格

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

语法格式如下:

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

(注:第二行分割表头和内容。- 有一个就行,为了对齐,多加了几个。

对齐方式:

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

示例:

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

效果如下:

轻松上手Markdown


五、高级技巧

1.支持的 HTML 元素

不在 Markdown 涵盖范围之内的标签,都可以直接在文档里面用 HTML 撰写。

目前支持的 HTML 元素有:<kbd> <b> <i> <em> <sup> <sub> <br>等 。

2.转义

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

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

Markdown 支持以下这些符号前面加上反斜杠来帮助插入普通的符号:

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

3.公式

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

 

 

 

相关标签: Markdown