Markdown 编辑器指南

1. 基础书写格式

1.1. 段落

在 Markdown 中,连续的一行或多行就是一个段落。用空行来进行切段。

这是第一个段落
我跟上面是同一个段落

这是第二个段落

1.2. 大纲

正确地使用大纲,可以帮助 Wiki 系统渲染目录,计算定位锚点,好处多多。

Markdown 中,使用 # 来定义大纲标题,有多少个 #,就表示是几级的大纲。比如:

# 这是一级标题(会生成<h1>标签)

这里是段落内容

## 这里是二级标题(会生成<h2>标签)

这里是段落内容

...

###### 这里是六级标题

这种书写方式非常直观自然。

1.3. 引用内容

引用部分的内容只需要在行首加上 > 就可以了。比如:

> To be or not to be, that is a question.

看起来是这样的:

To be or not to be, that is a question.

1.4. 强调文本

您可以使用加粗斜体来格式化文本内容。

加粗使用: **这种语法**
斜体使用: *这种语法*_这种语法_
还可以混合使用:**加粗文本中的_斜体_**

1.5. 删除线

你可以使用 ~~ 包裹一段文本让它拥有删除效果

这样来~~删除一段文本~~

2. 超链接和参考

2.1. 超链接

通过 [文本](url) 的形式来添加超链接。比如这个是一个腾讯云的超连接。

[腾讯云](https://www.qcloud.com/) - 控制创意,如此简单

2.2. 参考

2.2.1. 文本参考

如果文档中同一个链接多次使用,可以使用参考的方式。使用中括号可以把一个文本变为引用,如 [爱因斯坦],在文档的后续,需要指明参考文本和参考连接的对应关系:

[爱因斯坦]是一个伟大的科学家。

[爱因斯坦]: http://baike.baidu.com/view/2526.htm

渲染效果:

爱因斯坦是一个伟大的科学家。

2.2.2. 命名参考

如果不同文本要参考同一个链接,可以使用命名参考,其格式为[参考文本][参考名称]。在文档的后续,需要附上参考名称和链接的对应关系。比如

[微积分][Calculus](Calculus)是高等数学中研究函数的[微分](Differentiation)(Differentiation)、[积分][Integration](Integration)以及有关概念和应用的数学分支。

[Calculus]: http://baike.baidu.com/subview/3139/5376279.htm
[Differentiation]: http://baike.baidu.com/view/15986.htm
[Integration]: http://baike.baidu.com/subview/61339/5928878.htm

渲染出来是这样的:

微积分(Calculus)是高等数学中研究函数的微分(Differentiation)、积分(Integration)以及有关概念和应用的数学分支。

3. 列表

3.1. 无序列表

在行首添加 *- 可以开启列表模式,比如

* 第一,...
* 第二,...
* 第三,...

- 首先,...
- 其次,...
- 最后,...

有序列表

在行首添加数字,就可以开启有序列表模式,比如:

1. 打开冰箱
2. 把大象放进去
3. 关上冰箱

3.2. 列表嵌套

在上一级列表的基础上加两个空格,即可嵌套列表

1. 打开冰箱
  1. 用右手打开
  2. 轻轻地打开
2. 把大象放进去
  * 不要吐槽
    * 大象太大
    * 冰箱太小
    * 例子很无聊
3. 关上冰箱

整体效果:

  1. 打开冰箱
    1. 用右手打开
    2. 轻轻地打开
  2. 把大象放进去
    • 不要吐槽
      • 大象太大
      • 冰箱太小
      • 例子很无聊
  3. 关上冰箱

4. 表格

表格使用了直观的定义方式,使用 -| 分割行和列。

月份|收入|支出
----|----|---
8   |1000|500
9   |1200|600
10  |1400|650

看起来效果如下:

月份

收入

支出

8

1000

500

9

1200

600

10

1400

650

其中,航标题后的一行使用的横杆数量是不要求的,只是为了排版好看才人工对齐。比如你可以这样来定义上述表格。

月份|收入|之处
-|-|-
8|1000|500
9|1200|600
10|1400|650

你还可以使用 : 指定列的对齐方式。

月份(居中对齐)|收入(右对齐)|支出(左对齐)
:--------------:|-------------:|:------------
8               |1000          |500
9               |1200          |600
10              |1400          |650

看起来效果如下:

月份(居中对齐)

收入(右对齐)

支出(左对齐)

8

1000

500

9

1200

600

10

1400

650

5. 代码

5.1. 行内代码

在文本中使用 ` 包裹的内容会被识别为代码,比如

现在你可以不用 `document.getElementById()` 了,现代浏览器都把复制了 `id` 属性的元素放在了全局变量里。

渲染出来是:

现在你可以不用 document.getElementById() 了,现代浏览器都把复制了 id 属性的元素放在了全局变量里。

5.2. 多行代码

使用 ``` 来包裹多行的内容成为代码。

比如:

    ```
      var a = 0;
      var b = 1;
      var c = a + b;
    ```

5.3. 代码高亮

``` 的后面,可以指定代码的类型,如:

   ```js
    var dog = new Dog('dummy');
    dog.bark();

渲染的效果如下:

var dog = new Dog('dummy');
dog.bark();

原创声明,本文系作者授权云+社区-专栏发表,未经许可,不得转载。

如有侵权,请联系 yunjia_community@tencent.com 删除。

编辑于

我来说两句

0 条评论
登录 后参与评论

相关文章

来自专栏阮一峰的网络日志

CSS 框架 Bulma 教程

网页样式需要大量时间开发,最省事的方法就是使用 CSS 框架。 Bootstrap 是最著名的 CSS 框架,但是今天我想推荐另一个更轻量化、更易用的框架---...

2744
来自专栏Material Design组件

Material Design —卡片(Cards)

35110
来自专栏数据小魔方

三角符号凸显数据的盈亏趋势

今天要跟大家分享的技巧是用三角符号来凸显数据表中的盈亏趋势! ▽▼▽ 通常一张带有数据以及增长趋势表格,需要读者反复浏览才能明白其中的趋势和增减情况,可是如果你...

2747
来自专栏Thinks

SEO简易规范

最通用和安全的SEO规范 Title: l 采用倒装的格式 l 当前页面 – 父级 – 父级的父级 – 腾讯云 注:如果大于四级,请拉群协商;翻页不算级别;...

481
来自专栏hightopo

基于 HTML5 WebGL 的低碳工业园区监控系统

987
来自专栏IMWeb前端团队

拥抱sass,抛弃compass

为什么要用sass 在选择sass之前,我们先说下为什么要使用CSS Preprocessor。 大概两年前,CSS Preprocessor其实没有这么热,而...

1918
来自专栏王磊的博客

ECharts使用心得

ECharts百度旗下图标插件,在展示地图、雷达图等方面有很好的支持。 应用场景: 自动生成X轴的数据: 设置:xAxis的type=value || typ...

2627
来自专栏Android机动车

自定义View之客服好评View

这个版本主要的任务就是完成环信客服系统的集成,上一篇文章 仿IOS下载View 也是这个版本开发需求中的一小部分,那今天介绍一下另一个小需求 客服好评。 客服好...

935
来自专栏企鹅号快讯

应用广泛的语言ECMAScript 2018来了,新特性都在这里

原文:What’s new in ECMAScript 2018 作者:Paul Krill 翻译:不二 译者注:ECMAScript是应用广泛的语言,它常常被...

1918
来自专栏腾讯社交用户体验设计

[ISUX译]我为css变量狂 - 腾讯ISUX

953

扫码关注云+社区