Markdown - 应用场景 ¶
作者:KK
发表日期:2016.03.30
有些人会疑惑,学会了markdown的书写格式没错是能出那些预览,可是如果创建一个.md
文件后写了这些内容,那改天打开看的时候里面的内容不也是纯文本吗?----这还真是脑洞没开呀
md文件其实和html一样,就像是源代码文件,咱们写好的html代码都用浏览器打开浏览效果的,那md文件当然是用markdown文件浏览器来看的啦
但实际上这样比较少人做,纵观工作中有多少人安装markdown查看工具,所以并不是这样使用的,只能说"你可以这样用"
实际场景1 ¶
这是最多的,主要是程序员使用,像我的博客一样,用markdown写好内容,再用特定的转换器生成html文件,构造成一个文档
很多软件的官方文档,你们可以发现它们的排版没什么特别的,无非是标题,突出文本,代码,分割线等等,排版大同小异,可以看出,它们绝大部分都是使用markdown来书写这些文本并生成了html发布到网站上的。
这样的好处就是要改文档内容时只要快速编辑markdown文档就可以,并不需要进入程序后台,从数据库读出文档内容,通过网页富文本编辑器繁琐地设置各种字体排版格式才能发布,而且又不好迁移
下面我提供一些软件的文档网址,你看看是不是排版都差不多,其实他们只是用的markdown转换器不同,但排版方式几乎差不多,大部分都可以判断出来是使用markdown编写的
Phalcon框架的某文档(同时我也觉得Phalcon官方使用的markdown转换工具转换出来的样式更加好看,很想得到,不知有没有开源的,求大家一起帮忙挖出来呀!)
Stackflow的问答内容也是用markdown格式发表的
实际场景2 ¶
一些开源程序和软件开发者开发出东西后要给别人指导如何二次开发/使用软件,那么就需要指导文档了。他们都会用markdown写一份README.md
这样的文档,或者一份已经生成好的README.html
,所以这下你想起了吗?以前下载的很多软件除了安装文件之外,都带有这个文件吧,其实当你遇到安装问题时,这些说明里面或许有重要的提示呢!
这对于他们在更新软件后修改说明内容也很方便,直接打开文本文件就修改了
大家可能会疑惑为什么他们不用Word?这个嘛,有时候用户没安装Word,或者Word被他玩坏了,这样就不好了
实际场景3 ¶
例如CSDN或者Github上的用户发表一些言论内容有时候是富文本,但有时候又只是轻量级的富文本,这些内容中有重点,有标题,又有几大块内容,但是如果用类似UEditor这样的网页编辑器提供用户编辑
那用户输入大标题的文字后,又要鼠标拖远,再点击字体大小,选择合适的字号后再加粗什么的。好了,当他要分段时又要在编辑器上选择分割线工具插入一条线,要突出某一块内容时又要拖选内容设置背景色或字体色来吸引读者注意
那么当他使用markdown来写的话,前面加几个#号,后面加几个`号,中间加几个-号就能构造出标题,突出点和分割线这些了,就像我这个博客这些文章,排版需求没多复杂,有这些markdown元素我就能快速写文章,而不需要慢慢地选中内容再设置格式了
然后用户提交markdown内容到服务器,服务器再用专门的markdown格式编译工具转换成html即可
对了,为知笔记也支持markdown格式,所以在那上面写笔记也会挺方便的,不用慢慢设置内容格式
实际场景4 ¶
交接说明,其实和第1种的性质是一样,只是这是用在工作交接上
曾经有位前端工程师即将离职,于是他用markdown写下了一些工作相关的内容,包括一些工具的命令参数等,然后他用工具生成了HTML和PDF两种版本给我和新来的前端工程师阅读