Markdown快速入门

什么是Markdown

Markdown是一种轻量级标记语言,可以使用它向纯文本文档添加格式化元素。Markdown由John Gruber于2004年创建,现在是世界上最流行的标记语言之一。
使用Markdown与使用所见即所得编辑器是不同的。在Microsoft Word这样的应用程序中,单击按钮来格式化单词和短语,这些更改将立即可见。Markdown不是这样的。创建Markdown格式的文件时,将Markdown语法添加到文本中,以指示哪些单词和短语看起来应该不同。
例如,要表示一个标题,可以在它前面添加一个数字符号(例如# 标题一)。或者,要使一个短语加粗,可以在它的前后加上两个星号(例如,**这是个粗体**)。可能需要一段时间来适应文本中的标记语法,特别是如果你已经习惯了所见即所得的应用程序。

可以使用文本编辑器应用程序向纯文本文件添加标记格式元素。或者,也可以使用macOS、Windows、Linux、iOS和Android操作系统的众多Markdown应用程序之一。还有一些基于web的应用程序专门为用Markdown编写而设计。
根据使用的应用程序,可能无法实时预览格式化的文档。但是没关系。根据Gruber的说法,Markdown语法被设计为可读且不突现的,因此即使没有呈现Markdown文件中的文本,也可以读取。
Markdown格式化语法的首要设计目标是使其尽可能可读。其思想是,标记格式的文档应该按原样(即纯文本)发布,而不是看起来像用标记或格式说明进行了标记。

基本语法

这些是John Gruber的原始设计文档中概述的元素。所有的标记应用程序都支持这些元素。

元素 Markdown语法 HTML 显示效果
标题 # 标题一
## 标题二
### 标题三
<h1>标题一</h1>
<h2>标题二</h2>
<h3>标题三</h3>

标题一

标题二

标题三

粗体 **粗体文本** <strong>粗体文本</strong> 粗体文本
斜体 *斜体文本* <em>斜体文本</em> 斜体文本
引用 > 引用文本 <blockquote>引用文本</blockquote>
引用文本
有序列表 1. 第一项
2. 第二项
3. 第三项
<ol>
<li>第一项</li>
<li>第二项</li>
<li>第三项</li>
</ol>
  1. 第一项
  2. 第二项
  3. 第三项
无序列表 - 第一项
- 第二项
- 第三项
<ul>
<li>第一项</li>
<li>第二项</li>
<li>第三项</li>
</ul>
  • 第一项
  • 第二项
  • 第三项
代码 `code` <code>code</code> code
水平线 --- ---
链接 [百度](https://www.baidu.com) <a href="https://www.baidu.com">百度</a> 百度
图像 ![提示文字](image.jpg) <img src="image.jpg" alt="提示文字"> 提示文字

扩展语法

这些元素通过添加附加功能扩展了基本语法。并不是所有的标记应用程序都支持这些元素。

元素 Markdown语法 HTML 显示效果
表格 语法| 描述|
| ----------- | ----------- |
| 语法一 | 说明1 |
| 语法二 | 说明二 |
<table>
<tr>
<th>语法</th><th>描述</th>
</tr>
<tr>
<td>语法一</td><td>说明一</td>
</tr>
<tr>
<td>语法二</td><td>说明二</td>
</tr>
</table>
语法描述
语法一说明一
语法二说明二
代码块 ```
{"firstName": "John",
"lastName": "Smith",
"age": 25}
```
<code>
{"firstName": "John",
"lastName": "Smith",
"age": 25}
</code>
{"firstName": "John",
"lastName": "Smith",
"age": 25}
注解 这是个带注解的名字[^1]
[^1]: 这里写注解.
这是个带注解的名字<sup id="fnref:1">
<a href="#fn:1" class="footnote">1</a></sup>
这是个带注解的名字1
标题编号 ### 我的标题 效果请参考官网
定义列表 term
: definition
<dl><dt>term</dt><dd>definition</dd></dl>
term
definition
删除项 ~我要加删除线~ <del>我要加删除线</del> 我要加删除线
任务列表 - [x] 这是第一项
- [ ] 这是第二项
- [ ] 这是第三项
效果请参考官网

参考文档

官方文档快速入门

基本语法详细参考

扩展语法详细参考

这个是1的注解

posted @ 2019-04-03 17:12  云天  阅读(259)  评论(0编辑  收藏  举报