← 返回文章列表

Markdown 写作:先组织内容,再安排格式

一篇示例写作笔记,用列表、代码块和表格说明 Markdown 如何帮助表达。

这是一篇初始示例文章,用于展示博客排版,不代表站主的真实经历或观点。

本文为 Markdown 写作示例,内容与数据仅用于演示排版,不是本站的维护说明。

先给内容分层

Markdown 的方便之处,是写作时不用频繁切换格式工具。但格式并不会自动带来清晰的表达。动笔前,可以先用一句话概括主题,再把解释、例子和注意事项分开。一个段落尽量只承担一件事,阅读时就不容易迷路。

二级标题用来划分主要话题,三级标题适合继续拆分其中的步骤。不要只因为某行需要醒目,就把它设成标题;短语强调可以使用 粗体,文件名或语法片段则可以写成行内代码,例如 notes.md

列表负责并列,代码保留原样

没有先后顺序的要点适合无序列表。比如整理一段说明时,可以检查:

  • 有没有交代问题出现的条件。
  • 例子能不能帮助读者理解。
  • 结尾是否给出可执行的下一步。

如果内容必须依次操作,就换成有序列表。不要把很长的段落全部塞进列表项,必要的背景说明放在列表前面,通常更容易读懂。

展示代码时,用三个反引号包住内容,并注明语言。下面的 JavaScript 片段仅演示把两个词连接起来,不依赖额外工具:

const words = ["你好", "Markdown"];
console.log(words.join(","));

代码块会保留换行和缩进。解释代码作用的文字应放在块外,让读者先知道要看什么,再查看具体写法。

表格只放适合比较的内容

当信息具有相同维度时,表格比连续描述更直观:

内容类型推荐格式使用目的
并列要点无序列表方便逐项浏览
操作顺序有序列表明确执行次序
相似选项表格对照共同维度

表格单元格尽量简短,长解释留在正文。完成后再预览一次,检查标题层级、空行和代码围栏是否正确。不同编辑器对表格等扩展语法的支持可能不同,因此预览也是确认阅读效果的一步,而不只是检查文字有没有写错。

— 本文完 —