技术博客的 Markdown 排版清单:让文章更好读
【摘要】 同样一篇技术文章,排版好和排版差,阅读体验差别很大。下面是我每次发布前都会过一遍的清单,都是很小的习惯,但积累起来效果明显。标题层级不要跳级一级标题留给文章标题,正文从二级标题开始,层级依次往下。跳级会让阅读器生成的目录结构错乱,也不利于搜索引擎理解文章结构。代码块一定要标语言代码块标注语言后,高亮更准确,复制也更方便。比如写一段 shell:git clone https://exampl...
同样一篇技术文章,排版好和排版差,阅读体验差别很大。下面是我每次发布前都会过一遍的清单,都是很小的习惯,但积累起来效果明显。
标题层级不要跳级
一级标题留给文章标题,正文从二级标题开始,层级依次往下。跳级会让阅读器生成的目录结构错乱,也不利于搜索引擎理解文章结构。
代码块一定要标语言
代码块标注语言后,高亮更准确,复制也更方便。比如写一段 shell:
git clone https://example.com/demo.git
cd demo
./start.sh --check
如果代码很长,只贴关键片段,其余用文字说明,读者更容易抓住重点。
段落短一点
移动端阅读占比越来越高,三四行一段比较合适。一段话讲一个点,讲完就换段,比一大段密集文字友好得多。
善用列表和表格
并列的信息用列表,多个对象的多项属性用表格。表格比长段落更容易横向对比,但要控制列数,太多了在手机上会横向滚动。
图片要能自解释
截图前后各加一句说明,告诉读者“这张图在说明什么”。纯截图堆砌很难让读者跟上你的思路。
发布前自查
- 标题是否能让人一眼知道文章解决什么问题?
- 有没有大段无分隔的文字?
- 代码能否直接复制运行?
- 链接是否有效?
- 摘要是否写清楚了文章价值?
排版不是装饰,它本质上是在替读者节省时间。花十分钟自查,往往能换来更多的阅读和收藏。
【声明】本内容来自华为云开发者社区博主,不代表华为云及华为云开发者社区的观点和立场。转载时必须标注文章的来源(华为云社区)、文章链接、文章作者等基本信息,否则作者和本社区有权追究责任。如果您发现本社区中有涉嫌抄袭的内容,欢迎发送邮件进行举报,并提供相关证据,一经查实,本社区将立刻删除涉嫌侵权内容,举报邮箱:
cloudbbs@huaweicloud.com
- 点赞
- 收藏
- 关注作者
评论(0)