domain: markdown
第 05 节:代码、引用与分割线
本节 objectives:
- 能用反引号写出行内代码,知道它和普通文字的区别。
- 能用三个反引号写出多行代码块,并会加语言名触发语法高亮。
- 能用
>写出引用块,用三个以上的-或*写出分割线。先修:会写链接与图片(第 04 节) | 上一节 << 04 链接与图片 | 下一节 06 表格与结业实战 >>
教程里那些"和正文长得不一样"的命令,是怎么做到的?
你一定见过这样的技术教程:"打开终端,输入 npm install"——那个 npm install 看起来和周围的字体不一样,像是打字机打出来的。或者你见过别人截图分享一段完整的代码,四周还带着一个浅灰色的方框。这些都不是巧合排版,而是 Markdown 专门为"代码"设计的两种语法:一种用于句子里冒出来的一两个词,一种用于独立成块的一大段。
讲解
行内代码(Inline code):用一对反引号 ` 包住一个词或一小段文字,渲染后会用等宽字体显示,和周围的文字明显区分开,通常用来标出命令、文件名或代码片段[^S1]:
代码块(Fenced code block):如果要展示一整段多行代码或命令,在这段内容的上下各写一行三个反引号 ```,把内容包在中间[^S3]:
加语言名触发高亮:在开头那行三个反引号后面紧跟一个语言名(不加空格),大多数渲染器会按这个语言的规则给代码上色,让关键字、字符串等更容易分辨[^S3]:
这门课前面所有示例代码块(比如 # 标题 那些)用的都是 markdown 这个语言名——现在你知道为什么它们会带有特殊的颜色样式了。
引用块(Blockquote):在一行开头加 > 再加空格,这一行就会变成引用样式,通常显示为左侧一条竖线、文字颜色变浅,用来标出"这是别人说的话"或者"这是需要特别标注的说明"[^S1]:
多行引用需要每一行都加 >;如果引用中间要空一行分段,那一行也要单独写一个 >,否则空行会打断整个引用块。
水平分割线(Horizontal rule):单独一行写三个以上的 -、* 或 _,前后建议各留一个空行,渲染后会变成一条横线,用来把文档切分成明显不同的区块[^S1]:
跟我做一遍(worked example)
在编辑器里敲下面这段,观察行内代码、代码块、引用、分割线四种效果:
(提示:上面这个示例本身用了四个反引号包住整段演示内容,这样才能在里面正常展示一个三个反引号的 bash 代码块——这也是"代码块里还要放代码块"时的技巧:外层反引号数量要比内层多。你在自己的编辑器里操作时,直接照抄这段内容整体粘贴即可看到效果。)
观察要点:npm install 这几个字明显换了字体,嵌在句子中间;三行安装命令被框在一个独立区块里,保留了换行,还带有浅色背景;提示那一行左边有竖线、文字变浅;最下面出现一条横线把两部分内容分开。
换你补全(faded example)
下面这段笔记想表达:"先给一句提醒(用引用块),再给一段完整的三行命令(用代码块并标注 bash 语言),最后用分割线隔开下面的新话题",但符号还没写全:
提示:提醒句用什么符号开头,命令块的头尾符号是什么、语言名写在哪,分隔新话题用几个短横线。
答案:
接下来是常见问题排查。
Exercises
- 做法指引:在你的编辑器里写一份"如何安装一个软件"的简短说明,要求包含:一句用行内代码标出的单个命令(比如提到某个命令名)、一个三行以上的代码块(写几条你熟悉的操作步骤,哪怕是日常操作也行,比如"打开设置、点击账号、点击退出登录")、一句用引用块写的注意事项。
- 做法指引:把下面这段粘贴进编辑器,观察两行是否被渲染成了同一个连续的引用块(预览里应该是一整块带竖线的区域,而不是断成两截):
尝试把它改成"两条注意事项在同一个引用块里,但仍然分成两个可读的段落"。