markdown
markdown是目前IT领域最受欢迎的书写格式,文件的后缀名为.md
,目前很多主流的博客、技术社区之类的网站都支持使用markdown
的格式编辑,segmentFault
也是如此,书写了不少文章之后,我才了解了不少书写的乐趣,最开始也是写的不是很顺,主要是开始没有记录下很多方式。
Markdown 的目标是实现「易读易写」。
可读性,无论如何,都是最重要的。一份使用 Markdown 格式撰写的文件应该可以直接以纯文本发布,并且看起来不会像是由许多标签或是格式指令所构成。Markdown 语法受到一些既有 text-to-HTML 格式的影响,包括 Setext、atx、Textile、reStructuredText、Grutatext 和 EtText,而最大灵感来源其实是纯文本电子邮件的格式。总之, Markdown 的语法全由一些符号所组成,这些符号经过精挑细选,其作用一目了然。比如:在文字两旁加上星号,看起来就像强调。Markdown 的列表看起来,嗯,就是列表。Markdown 的区块引用看起来就真的像是引用一段文字,就像你曾在电子邮件中见过的那样。
兼容html
Markdown 语法的目标是:成为一种适用于网络的书写语言。
Markdown 不是想要取代 HTML,甚至也没有要和它相近,它的语法种类很少,只对应 HTML 标记的一小部分。Markdown 的构想不是要使得 HTML 文档更容易书写。在我看来, HTML 已经很容易写了。Markdown 的理念是,能让文档更容易读、写和随意改。HTML 是一种发布的格式,Markdown 是一种书写的格式。就这样,Markdown 的格式语法只涵盖纯文本可以涵盖的范围。
不在 Markdown 涵盖范围之内的标签,都可以直接在文档里面用 HTML 撰写。不需要额外标注这是 HTML 或是 Markdown;只要直接加标签就可以了。
书写方式
-
段落
段落是markdown
的最常见部分,任何前后空白的部分都是段落,相等于html
中的p
元素,需要注意以下:- 段落中的连续多个空白会被合并为一个空白符号
- 段落内部换行需要组合
空格+空格+enter
的组合键
- 换行
markdown
支持html
中的br
换行,但是正常书写的空行也会有换行的效果,段内换行需要使用空格+空格+enter
的组合键 -
标题 #
虽然有很多的支持方式,但是还是统一下比较好,总计六个标题格式:-
#
代表一级标题 -
##
代表二级标题 -
###
代表三级标题
-
-
引用 >
引用是比较特别的效果:书写这样=>>这是一段引用
, 对应得展示效果如下:这是一段引用
-
列表
无序列表使用*
比较的合适,有序列表使用1.
的组合,都需要记住后面的空白,层级可以有多曾层嵌套,每层前面添加tab
或者4个空格即可:-
一级
-
二级
- 三级
-
-
-
代码
代码可以使用tab
或者`
*4来表示 ,也就是如下书写:````
````
var test ='test';
````
展示效果如下:var test ='test';
-
链接&图片
- 链接的格式:
*[链接](https://segmentfault.com/u/caoweiju)
展示效果就这样的:链接 - 图片格式:
*![图片](https://sfault-avatar.b0.upaiyun.com/277/162/277162201-5976c6a68a84c_huge256)
展示效果就这样的:
- 链接的格式:
-
其他【强调、分割线、】
- 强调
可以是**这样**
书写即可,效果:强调 - 分割线
书写----
,效果如下这条线;
- 强调
结束
这些常用的方法以及可以写出简明的文档了,git上的文档基本都是markdown
格式的,所以学会使用还是很好的,很多应用还进行了扩展,支持了表格、流程图等书写,但是只要掌握自己的平时习惯就好。
**粗体** _斜体_ [链接](http://example.com) `代码` - 列表 > 引用
。你还可以使用@
来通知其他用户。