1.为什么要用Markdown
2.常用语法
2.1标题
2.2粗体、斜体
2.3空格、居中
2.4分割线
2.5列表
2.6高亮代码
2.7引用
2.8表格
2.9超链接、图片
3.常用编辑器
4.最后想说的
1.为什么要用Markdown
很多人写文档都喜欢用word,但是有没有觉得很长的时间,我们都在调格式,其实真正的技术文档,我们应该把主要的经历花费在技术内容中,而不是在格式的调整中。
当我们的word格式的文档需要更新时,不同的版本不方便管理和控制。
We believe that writing is about content, about what you want to say - not about fancy formatting.
我们坚信写作写的是内容,所思所想,而不是花样格式。
— Ulysses for Mac
Markdown优点:
- 专注你的文字内容而不是排版样式,安心写作
- 可以转换成pdf、html等格式
- 纯文本内容,兼容所有的文本编辑器与字处理软件
- 文档版本可控
- 可读、直观、学习成本低
- 技术青年
2.常用语法
2.1标题
语法:
1 | # 一级标题 |
效果:
一级标题
二级标题
三级标题
四级标题
五级标题
六级标题
2.2粗体、斜体
语法:
1 | **粗体** |
效果:
粗体
粗体
斜体
斜体
2.3.空格、居中
语法:
1 | 空格,一个 为一个空格 |
效果:
空格,一个 为一个空格
2.4分割线
语法:
1 | --- |
效果:
文字删除线
2.5列表
语法:
1 | - 无序列表项目 |
效果:
- 无序列表项目
- 无序列表项目
- 无序列表项目
- 无序列表项目
- 无序列表项目
- 无序列表项目
- 有序列表项目
- 有序列表项目
- 有序列表项目
- 外层列表项目
- 内层列表项目
- 内层列表项目
- 内层列表项目
- 外层列表项目
2.6高亮代码
语法:
首尾都要输入三个括号里的符号(`)
效果:
1 | if (YourIdea) |
2.7引用
语法:
在需要添加引用的内容之前加入符号>1
2> 这是一个引用
> I think so
效果:
这是一个引用
I think so
2.8表格
语法:
1 | | ABCD | EFGH | IJKL | |
效果:
ABCD | EFGH | IJKL |
---|---|---|
1 | 2 | 3 |
4 | 5 | 6 |
7 | 8 | 8 |
2.9超链接、图片
语法:
1 | 超链接: |
1 | 图片: |
效果:
超链接:
Tianger’s Family
图片:
公众号:天歌的编程小结
3.常用编辑器
在线编辑器:
作业部落
支持流程图、序列图
地址:https://www.zybuluo.com/mdeditor简书
马克飞象 Marxico
内容可以同步到印象笔记中
地址:https://maxiang.io/
离线编辑器:
MarkdownPad
下载地址: http://markdownpad.com/
CuteMarkEd
Firefox插件:
- Markdown Viewer
下载地址: https://addons.mozilla.org/zh-CN/firefox/addon/markdown-viewer/?src=ss
Chrome插件:
Markdown preview
下载地址:http://www.cnplugins.com/office/markdown-preview/download.html
Markdown preview plus
下载地址:http://www.cnplugins.com/fuzhu/markdown-preview-plus-dzte/download.html
4.最后想说的
Markdown的入门介绍就到这里的,相信看到这里,基本上已经能够开始进行Markdown的编写了,那么让我们加入MD,一起拥抱开源!
本文使用Markdown编写,可以下载作为例子参考:
下载地址: