James0 2020-01-30
https://blog.csdn.net/yangguo52047/article/details/102585058
文章目录
一、为什么使用Markdown?
二、常用的语法
2.1 标题
2.2 列表
2.3 文本样式
2.4 代码片
2.5 目录
三、总结
一、为什么使用Markdown?
使用传统的富文本编辑器的时候,需要频繁的把手从键盘移动到鼠标上,这样便分散了注意力。
使用Markdown的时候,可以进入沉浸式写作,不用为文字排版而分心,效率更高。
二、常用的语法
不同的Markdown编辑器有不同的语法,但只要学会常用的几种,就足以进行日常的写作。
2.1 标题
标题的标准语法:
# 一级标题
## 二级标题
### 三级标题
标题的最佳实践:
# 1. 一级标题
## 1.1 二级标题
### 1.1.1 三级标题
在标题前面写上序号,以后生成目录的时候,就可以一目了然。
2.2 列表
有序列表:
1 红
2 绿
3 蓝
无序列表:
* 红
* 绿
* 蓝
列表的最佳实践:
我的建议是多用无序列表。
无序列表最多二层嵌套,否则层次结构混乱。
有序列表可以用在标题前加序号替代。
2.3 文本样式
加粗:**加粗文本**,文本的加粗,就起到了强调的作用,只在最关键的地方加粗,加粗用的太多,文章就显得花里胡哨,让人抓不住重点。
2.4 代码片
代码行:左右各一个`,行级代码不能换行。
`代码行`
1
代码块:
?```
function test() {
console.log("notice the blank line before this function?");
}
?```
加上编程语言,代码高亮显示
?```ruby
require ‘redcarpet‘
markdown = Redcarpet.new("Hello World!")
puts markdown.to_html
?```
最佳实践
短小的,单行的代码,用代码行
多行代码,写成代码块
2.5 目录
语法:[toc]
目录的层次结构,应该尽可能的浅,只有在写书的时候,才用得上三级标题。
建议文章开头提供目录,放在概述之下。
三、总结
虽然Markdown的语法远不止此,但文章最重要的是内容、而不是形式,灵活运用上述语法就足以写出优美的文章