首页
学习
活动
专区
工具
TVP
发布
精选内容/技术社群/优惠产品,尽在小程序
立即前往

markdown写文档基础

声明

本公众号所有内容,均属微信公众号: 开源优测 所有,任何媒体、网站或个人未经授权不得转载、链接、转贴或以其他方式复制发布/发表。已经本公众号协议授权的媒体、网站,在使用时必须注明"稿件来源微信公众号:开源优测",违者本公众号将依法追究责任。

对于经常写文档的我们,时常被排版所困扰,今天介绍如何用markdown来写日常的文档。

首先工具,笔者日常使用visual studio code来写,有丰富的markdown插件,至于配置,请百度visual studio code markdown配置即可。下面我们来看一下基本一张效果图:

左边为markdown语法写的,右边为预览效果

正常情况下掌握上图中的markdown语法足以写出好看的排版文档了,完整的语法示例如下:

# 一级标题

## 二级标题

### 三级标题

#### 四级标题

##### 五级标题

### 分割线如下

---

### 有序列表

1.列表项1

2.列表项1

3.列表项1

### 无序列表

-列表项

-列表项

-列表项

### 表格

| 序号 | 姓名 | 年龄 | 职业 |

|---|---|---|---|

| 1 | 苦叶子 | 108 | 呵呵 |

| 2 | 开源优测 | 1 | 哈哈 |

### 引入图片

下面是引入图片的方法

格式:

![图片说明](相对或绝对路径)

示例:

![python3手册](images/python3.png)

### 代码块

下面是文中嵌入代码实例

```python

#! -*- coding:utf-8 -*-

importos

__author__ ="苦叶子"

if__name__=="__main__":

print("这是代码块示例")

```

### 链接

### 文本块

>开源优测

>积微速成计划

>共同成长

>1.要坚持

>2.要努力

>3.用心

### 小结

开源优测公众号所有的文章均采用markdown进行写作

  • 发表于:
  • 原文链接http://kuaibao.qq.com/s/20180113A0HZE900?refer=cp_1026
  • 腾讯「腾讯云开发者社区」是腾讯内容开放平台帐号(企鹅号)传播渠道之一,根据《腾讯内容开放平台服务协议》转载发布内容。
  • 如有侵权,请联系 cloudcommunity@tencent.com 删除。

扫码

添加站长 进交流群

领取专属 10元无门槛券

私享最新 技术干货

扫码加入开发者社群
领券