Markdown 入门:用纯文本写出整洁的文档
写文档时,很多人第一反应是打开一个排版软件,调字体、调字号、拖表格,写了没几行,时间全花在了格式上。其实对大多数技术笔记、项目说明和博客文章来说,并不需要这么重的工具。Markdown 就是一种用纯文本写作的方式:你只管写内容,用几个简单的符号标出标题、列表和重点,剩下的排版交给工具自动完成。
先从标题说起。Markdown 里用井号表示标题,井号越多,标题级别越小。一个井号是一级标题,两个井号是二级标题,以此类推。写文章时先搭好标题骨架,整篇内容的结构就一目了然了。标题不是越多越好,每一段只解决一个小问题,标题就是这一段内容的提纲,读者扫一眼标题,就能知道这篇文章讲了什么、按什么顺序讲。
段落是 Markdown 里最省事的部分。空一行就是一个新段落,不用特意设置首行缩进,也不用担心换行会不会断错。想强调某个词,可以在它两边加上星号,变成粗体或者斜体,重点一下子就突出来了。需要引用别人的一句话时,在行首加一个大于号,整段就会变成引用块,适合放结论、定义或者注意事项。
列表是整理思路的好帮手。无序列表用短横线开头,适合罗列要点;有序列表用数字加圆点开头,适合写步骤。写操作指南的时候,把步骤一条一条列出来,比写成一大段话清楚得多。列表还可以嵌套,缩进一层就是子项,用来展开细节刚刚好。新手常犯的错误是列表符号后面忘了加空格,符号贴着文字就失效了,记得留出一个空格再写内容。
代码是技术文档里少不了的部分。行内的小段代码用一对反引号包起来,比如一个命令名、一个文件名,放在句子里既醒目又不会打乱阅读。整块代码则用三对反引号围起来,还可以在第一行注明语言,工具会自动给代码上色。写代码片段时尽量只放关键部分,太长的完整程序反而会淹没重点,读者更需要的是看懂思路,而不是逐行抄写。
表格和分割线能让文档更整齐。表格用竖线分隔各列,用短横线分隔表头和内容,适合对比几个选项、列出参数说明。内容一多就容易写乱,建议先在纸上想好有几列、每列放什么,再动手写。分割线用三个短横线表示,适合在文章的不同部分之间划出界限,但不要滥用,一篇文章里用一两次就够了。
最后说说写作习惯。先写内容、后调格式,是 Markdown 带来的最大好处:写的时候不用分心,改的时候也容易,因为全文就是纯文本,换个工具打开也不会乱。建议把写好的文档保存在版本管理里,改动历史一清二楚,团队协作时也不怕互相覆盖。刚开始可以从一篇读书笔记、一份项目说明练起,用熟标题、段落、列表和代码这几样,日常写作基本就够用了。
- 点赞
- 收藏
- 关注作者
评论(0)