DailyWise

实用工具

Markdown 实用完全指南

你会真正用到的每个 Markdown 功能,配真实示例、那些悄悄出错的边缘情况,以及如何把文档写得干净。

Markdown 实用完全指南

Markdown 是网页写作里安静的默认格式——README、笔记、聊天消息、文档,以及越来越多的发布工具都接受它。它小到一晚就能学会,大到足以排版一整本书。这篇指南覆盖你会真正用到的功能,配真实示例,并点出那些悄悄搞乱文档的边缘情况。

核心:标题、强调、列表

这四样构成任何 Markdown 文档的绝大部分。

  • 标题。 一到六个井号,从 <h1> 到 <h6>。一份文档里最多用两级——五级标题的层级结构,通常说明文档需要重构,而不是多加几个井号。
    • # 一级
    • ## 二级
    • ### 三级
  • 强调。 *斜体* 或 _斜体_ 强调一个词;**粗体** 或 __粗体__ 加重语气。可以嵌套(**a *b* c**),但保持一层嵌套以内。
  • 列表。 - 或 * 是无序,1. 是有序。列表项缩进两个空格即可嵌套。
  • 链接。 [标签](https://example.com) 是链接,![替代文本](image.png) 是图片。标签是读者看到的文字;替代文本是屏幕阅读器朗读的内容。

人们用得不多的功能

有几个块状元素能做的事,比多数写作者以为的多。

  • 引用。 行首加 > 。多段引用就连续几行 > 。适合引用来源或突出一个定义。

  • 代码。 行内代码用反引号(`code`),代码块用三个反引号加语言标签以启用语法高亮。一定要加语言——高亮靠的就是它。

  • 表格。

    列 A列 B
    单元格 1单元格 2

    表格是 Markdown 里最啰嗦、最费神的元素;长表格往往不如一个列表清楚。

  • 分隔线。 单独一行三个连字符(---)。少用——标题几乎总是更好的分段方式。

那些会出错的边缘情况

文档悄悄出问题的地方就在这里。

  1. 词内下划线。 snake_case 在多数解析器里会把中间渲染成斜体。如果你写很多代码标识符,优先用连字符或反引号。
  2. 未转义字符。 正文里的字面 *、_ 或反引号需要用反斜杠转义,否则会被当成标记。
  3. 块前后的空行。 标题、列表、围栏代码块,前后通常需要空行,否则会和上下的段落黏在一起。
  4. 一个列表项只讲一件事。 一个列表项若含完整段落,应拆开;列表是给并列的短项用的,不是给套了破折号的段落用的。

如何把文档写得干净

  • 先用标题搭骨架,再填正文。
  • 一个段落只讲一个想法;话题一转就断开。
  • 带描述性标签的链接,胜过裸 URL。
  • 读渲染后的结果,而不是源码——Markdown 是你作为 HTML 来读的格式,两者并不总是一致。

为什么本地转换器关心这个

干净的 Markdown 文档是文本文件最可移植的形态。它在任何编辑器里能打开、在任何浏览器里能渲染、转 PDF/HTML/Word 无损。这就是为什么当一份文档需要”跑起来”时,转成 Markdown 往往是正确的一步——而这正是 DailyWise 转换器被造出来要做的事:全程在你的设备上完成,什么都不上传。

← 全部文章