首页
学习
活动
专区
工具
TVP
发布
社区首页 >专栏 >markdown编辑器书写格式说明

markdown编辑器书写格式说明

原创
作者头像
小芭乐
修改2017-12-06 16:49:07
1.5K0
修改2017-12-06 16:49:07
举报
文章被收录于专栏:小芭乐的专栏小芭乐的专栏

GFM 是 Github 拓展的基于 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) 的形式来添加超链接。比如这个是一个百度脑图的超连接。

[百度脑图](http://naotu.baidu.com) - 控制创意,如此简单

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 属性的元素放在了全局变量里。

原创声明:本文系作者授权腾讯云开发者社区发表,未经许可,不得转载。

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

原创声明:本文系作者授权腾讯云开发者社区发表,未经许可,不得转载。

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

评论
登录后参与评论
0 条评论
热度
最新
推荐阅读
目录
  • 1. 基础书写格式
    • 1.1. 段落
      • 1.2. 大纲
        • 1.3. 引用内容
          • 1.4. 强调文本
            • 1.5. 删除线
            • 2. 超链接
              • 2.1. 超链接
              • 3. 列表
                • 3.1. 无序列表
                  • 有序列表
                    • 3.2. 列表嵌套
                    • 4. 表格
                    • 5. 代码
                      • 5.1. 行内代码
                      领券
                      问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档