前往小程序,Get更优阅读体验!
立即前往
首页
学习
活动
专区
工具
TVP
发布
社区首页 >专栏 >markdown写文档基础

markdown写文档基础

作者头像
苦叶子
发布2018-04-09 15:41:22
2.6K0
发布2018-04-09 15:41:22
举报
文章被收录于专栏:开源优测

对于经常写文档的我们,时常被排版所困扰,今天介绍如何用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进行写作

本文参与 腾讯云自媒体同步曝光计划,分享自微信公众号。
原始发表:2018-01-13,如有侵权请联系 cloudcommunity@tencent.com 删除

本文分享自 开源优测 微信公众号,前往查看

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

本文参与 腾讯云自媒体同步曝光计划  ,欢迎热爱写作的你一起参与!

评论
登录后参与评论
0 条评论
热度
最新
推荐阅读
领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档