一般前端做过框架项目或者逛过 github 的都知道有个项目说明文件README.md
此文件主要可以记录一些项目关键信息和使用文档及流程
这个文件就是 markdown 文件
其实 markdown 文件远不止用在项目中
也可以快速写出很漂亮的文档文件，用于各个方面
这篇文章就介绍下如何编写和预览这个.md文件格式
编写一个 .md 文件
创建一个.md格式文件
.md 文件编写工具
mac上可以使用 Typora 非常好用能看到实时效果
vscode编辑器也可以编写预览 .md 文件
谷歌浏览器markdown插件也可以编写和预览
其余的可以根据自己的喜好去搜索相应的工具
按照 .md 文件基本语法进行编写
.md 基本编写语法
# 一级标题 ## 二级标题 ### 三级标题 #### 四级标题 ##### 五级标题 ###### 六级标题 # 无序列表和有序列表 - 和 1. - 无序列表 - 无序列表 - 无序列表 1. 有序列表 2. 有序列表 3. 有序列表 # 区块引用> - 比如这是一句名言 > 注意这句话是某个伟人说的 # 分割线 --- - 无序列表 --- 1. 有序列表 # 链接[链接文字]紧跟(链接地址 'title') - [百度](www.baidu.com) - [淘宝](taobao.com '点我查看') # 图片![图片名]紧跟(图片路径)  # 复选框- [ ] - [ ] 这是一个复选框 # 代码`` 或者 `````` `<h1>这是一行代码</h1>` ```html <h1>这是多行代码</h1> <h1>这是多行代码</h1> <h1>这是多行代码</h1> ``` # 表格 |name|age|sex| | name | age | sex | | ---- | ---- | :--: | | 张三 | 20 | 男 | | 放到 | | | | | | | # 强调**斜体四个星加粗 *字体斜体* **字体加粗** # 删除线 ~~删除我~~
发表评论：