Markdown 从入门到使用

Markdown是一款非常容易上手的轻量标记语言。当前许多网站都广泛使用 Markdown 来撰写帮助文档或是用于论坛上发表消息。

本文转自“旅途的博客”原文链接

Markdown 简介

  • Markdown 是一种轻量级标记语言,它允许人们使用易读易写的纯文本格式编写文档。
  • Markdown 编写的文档可以导出 HTML 、Word、图像、PDF、Epub 等多种格式的文档。
  • Markdown 编写的文档后缀为 .md, .markdown。

Markdown 应用

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

编辑器

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

Markdown 标题

Markdown 标题有两种格式。

使用 = 和 - 标记一级和二级标题

= 和 - 标记语法格式如下:

一级标题
=================

二级标题
-----------------

使用 # 号标记

使用 # 号可表示 1-6 级标题,一级标题对应一个 # 号,二级标题对应两个 # 号,以此类推。

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

Markdown 段落

Markdown 段落没有特殊的格式,直接编写文字就好,段落的换行是使用两个以上空格加上回车。
也可以在段落后面使用一个空行来表示重新开始一个段落。

字体

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

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

分隔线

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

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

删除线

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

~~baidu.com~~

下划线

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

带下划线文本

脚注

脚注是对文本的补充说明。
Markdown 脚注的格式如下:

创建脚注格式类似这样[^1]。

[^1]: 学习才有前途!!!

Markdown 列表

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

无序列表

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

* 第一项`
* 第二项`
* 第三项`
+ 第一项
+ 第二项
+ 第三项
- 第一项
- 第二项
- 第三项

有序列表

有序列表使用数字并加上 . 号来表示。

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

列表嵌套

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

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

Markdown 区块

Markdown 区块引用是在段落开头使用 > 符号 ,然后加上一个空格:

> 区块引用
好好学习
天天向上

区块嵌套

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

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

区块中使用列表

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

列表中使用区块

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

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

Markdown 代码

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

`printf()` 函数

代码区块

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

    function(){
     console.log('好好学习,天天向上!')
     }

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

\```javascript
$(document).ready(function () {
  alert('好好学习,天天向上!');
});
\```

Markdown 链接

普通链接

[链接名称](链接地址)

或者

<链接地址>

例如:

这是一个链接[百度一下,你就知道](https://www.baidu.com/)

直接使用链接地址:


高级链接

可以通过变量来设置一个链接,变量赋值在文档末尾进行:

这个链接用 1 作为网址变量` [Google][1]
这个链接用 baidu 作为网址变量` [BaiDu][baidu]
在文档的结尾为变量赋值(网址)

[1]: http://www.google.com/
[baidu]: http://www.baidu.com/

Markdown 图片

Markdown 图片语法格式如下:

![alt 属性文本](图片地址)

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

例如:

![小图片](http://b-ssl.duitang.com/uploads/item/201809/09/20180909200211_vikkq.thumb.700_0.jpeg)

![小小图片](http://file01.16sucai.com/d/file/2013/0527/20130527085528725.jpg "小小图片")

也可以使用变量:

这个链接用 1 作为网址变量 [小图片][1]
然后在文档的结尾为变量赋值(网址)

[1]: http://b-ssl.duitang.com/uploads/item/201809/09/20180909200211_vikkq.thumb.700_0.jpeg

Markdown 不能指定图片的高度与宽度,可以使用普通的 标签来指定图片的宽高。


Markdown 表格

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

语法格式如下:

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

对齐方式

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

你可能感兴趣的:(开发工具问题系列)