Markdown 语法上手 ( 先学这 8 种 )

电商报
2014-12-02 14:04
概述

Markdown 是程序员必学技能之一,然而有时其丰富多样的语法却让新人望而生畏。

此篇文章作为 Markdown 上手教程,只教授你 8 个最常用的语法,记住这几个语法以后,就可以在你每篇文章中践行。等具备足够的使用经验后,再进一步学习 完整的 Markdown 语法

1. 标题

语法格式:'#'+'空格'+'文本'

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

图例:

注:
# 和标题之间建议保留一个字符的空格,这是最标准的 Markdown 写法;
一般情况下,文章的标题会被系统渲染为『一级标题』,所以请避免在文章内容中使用『一级标题』。
请善用二级和三级标题,电商报 文章模块会自动为您生成 TOC,这会让文章结构更加清晰,如下:

2. 列表

列表格式也很常用,在 Markdown 中,你只需要在文字前面加上 - 就可以了,例如:

- 文本一 - 文本二 - 文本三

如果你希望有序列表,也可以在文字前面加上 1. 2. 3. 就可以了,例如:

1. 文本一 2. 文本二 3. 文本三

图例:

3. 链接和图片

在 Markdown 中插入链接需要使用 [显示文本](链接地址) 这样的格式语法。例如:

[电商报](https://www.dsb.cn)

在 Markdown 中,插入图片不需要其他按钮,你只需要使用![](图片链接地址)这样的语法即可,例如:

![](https://upload.nsg.cn/uploads/images/201806/12/1/Owic58YjaW.jpeg?imageView2/2/w/1240/h/0)

注:插入图片的语法和链接的语法很像,只是前面多了一个 !。

图例:

电商报 上图片显示时会加阴影,如果你想去除阴影的话,可以使用以下方式:

<img src="https://img1.dsb.cn/images/202006/10/2/PQwyT4WIsE.jpg!large" class="rm-style">

图例:

注:电商报 编辑器上传图片,只需要将图片拖拽丢入『编辑窗口』内,或者复制图片在『编辑窗口』内黏贴即可上传。

4. 引用

写作时经常需要引用他人的文字,在 Markdown 中,你只需要在你希望引用的文字前面加上 > 即可,例如:

Markdown 是一种轻量级标记语言,它允许人们使用易读易写的纯文本格式编写文档,然后转换成格式丰富的 HTML 页面。

图例:

5. 行内代码

行内的代码使用 ` 包起来即可,一般在描述类、函数、文件名称及路径时使用,如:

电商报 框架的所有配置文件都保存在 `config` 目录中。可以使用 `config()` 辅助函数来读取。

图例:

6. 代码高亮

如下是代码段的语法:

```编程语言 这是代码段 ```

例如:

```php class Order extends Model { ... public function scopeDelivered($query) { return $query->where('status', 'delivered'); } public function scopePaid($query) { return $query->where('paid', true); } } $orders = Order::delivered()->paid()->get(); ```

图例:

注:在 电商报 上,每一个栏目都设定了默认的代码高亮语法,例如 PHP 和 电商报 默认使用 php 作为默认高亮语法,当你只使用 ``` 而未设置语法时,此功能会被用上。

7. 粗体和斜体

Markdown 的粗体和斜体非常简单,用两个 * 包含一段文本就是粗体的语法,用一个 * 包含一段文本就是斜体的语法。例如:

Markdown 的 **粗体***斜体* 非常简单。

最终显示的就是下文:

Markdown 的 粗体斜体 非常简单。

图例:

8. 表格

基础的表格语法:

项目 | 价格 -------- | --- iPhone | $560 iPad | $780 iMac | $1000

可以使用冒号来定义对齐方式:

| 项目 | 价格 | 数量 | | :-------- | --------:| :--: | | iPhone | 6000| 5 | | iPad | 3800| 12 | | iMac | 10000| 234 |

图例:

结语

Markdown 编写是开发者的必备技能,尤其在撰写技术文档上,更加离不开 Markdown 语法。如果对 Markdown 语法不熟悉,本篇文章罗列了使用频率最高的 8 个语法,你可以多看几遍,或者打开 编辑器 直接尝试,这样会记得更加牢固。

在掌握了以上的简单语法后,推荐查阅 完整 Markdown 语法

1、该内容为作者独立观点,不代表电商报观点或立场,文章为作者本人上传,版权归原作者所有,未经允许不得转载。
2、电商号平台仅提供信息存储服务,如发现文章、图片等侵权行为,侵权责任由作者本人承担。
3、如对本稿件有异议或投诉,请联系:info@dsb.cn
相关阅读
使用 Markdown 编辑器撰写技术文章,只专注于内容和技术,不再费心排版的问题。这是一份简要的 Markdown 引导指南,希望可以帮助您顺利的开始使用 Markdown 编辑器
Markdown 语法完整版
如果你觉得语法太多太难记,可以先从 . Markdown 语法上手( 先学这8种 )学起。 概述 宗旨 Markdown 的目标是实现「易读易写」。 可读性,无论如何,都是最重要的。一份使用 Markdown 格式撰写的文件应该可以直接以纯...
8月3日消息,印象笔记发布新版APP,新增专为中国用户开发的Markdown、电脑端密码锁、Wigdet剪藏等功能。这是印象笔记重组为独立实体并拥有产品研发自主权“中国化”后的又一动作。此外,作为与腾讯社交媒体集团战略合作的一部分,印象笔记与QQ空间进行了分享功能的首次尝试。
排版规范
排版整洁对一篇文章来讲非常重要,请注意一下: 英文专有名词首字母需大写;英文的左右 必须 保持一个空白,避免中英文字黏在一起;中文 必须 使用全角标点符号;必须 严格遵循 Markdown 语法;「加亮」和「加粗」和「[链接]」都需要在左右保持一个空格;篇幅较长的代码里,请多使用代码注释;中英文排版,参考此页。为了保证文档品质,电商报里的所有文档,都必须严格遵照以上规范。