对于经常写文档的我们,时常被排版所困扰,今天介绍如何用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 -*- import os __author__ = "苦叶子" if __name__ == "__main__": print("这是代码块示例") ``` ### 链接 [开源优测](http://weixin.sogou.com/weixin?type=1&query=开源优测&ie=utf8&s_from=input&_sug_=n&_sug_type_=) ### 文本块 > > 开源优测 > 积微速成计划 > 共同成长 > > 1. 要坚持 > 2. 要努力 > 3. 用心 > ### 小结 开源优测公众号所有的文章均采用markdown进行写作