Markdown 是技术写作者的标配。语法简单，但写出易读、美观的文章仍然需要一些技巧。以下是几条我遵循的原则。

标题层级

文章应该有清晰的结构。通常：

  • # 用作文章标题（由模板自动渲染）
  • ## 用作主要章节
  • ### 用作子章节
  • 避免使用 #### 及以下的深层嵌套——如果内容需要那么多层级，或许该拆成两篇文章

代码块

始终指定语言以获得正确的语法高亮：

```python
def hello():
    print("Hello, World!")
```

渲染效果：

def hello():
    print("Hello, World!")

行内代码用反引号包裹：import this。

列表和引用

无序列表适合并列要点，有序列表适合步骤说明：

  1. 第一步
  2. 第二步
  3. 第三步

引用块用来强调关键点或引用外部内容：

简洁是智慧的灵魂，冗长是肤浅的藻饰。 — 莎士比亚

链接和图片

  • 外部链接用 [文字](URL)
  • 内部链接用 Jekyll 的 {% link _posts/xxx.md %}
  • 图片加上替代文本：![描述](URL)

段落节奏

一段话不要超过 5 行。长段落让人窒息，适当的空白让阅读更轻松。

善用粗体标记关键词，但不要在一段话里用超过 3 次——否则反而没有重点。

以上就是我遵循的一些写作习惯。说到底，好的技术文章不在于辞藻华丽，而在于结构清晰、表达准确。