这些生活窍门将改变您编写 Markdown 的方式!

2025-05-28

这些生活窍门将改变您编写 Markdown 的方式!

如果您是开发人员,您很可能之前遇到过 markdown 编辑器(无论您是否知道)。

GitHub、DEV、许多工单追踪器、大多数文档和博客平台(咳咳……Medium……)都支持 Markdown。熟练掌握 Markdown 语法将有助于你作为开发者更有效地沟通。

有很多资源和速查表可以帮助你从基础开始学习(比如这个很棒的 gist)。在这篇文章中,我将分享一些我见过的不太常用或文档不太完善的技巧。

有序列表

有序列表的语法非常简单:

1. Item one
2. Item two
3. another item
Enter fullscreen mode Exit fullscreen mode

呈现为:

  1. 第一项
  2. 第二项
  3. 另一件物品

但你是否曾经写过一个很长的清单,然后发现中间漏掉了一项?回去补上它,然后修改所有后续项目的编号,这肯定很烦人……

但其实你不必这么做!Markdown 不会在意数字,只要你有一个项目列表,前面有数字,无论什么数字,它都会以有序列表的形式呈现。

下列:

1. Item one
2. Item two
3. another item

1. Item one
1. Item two
1. another item

4. Item one
6. Item two
765. another item
Enter fullscreen mode Exit fullscreen mode

全部渲染为:

  1. 第一项
  2. 第二项
  3. 另一件物品

我喜欢的风格是在所有项目前面都使用 1,但是如果您更喜欢使用实际的数字,并且发现自己需要在第 7 项和第 8 项之间插入一个新项目,那么您也可以为新项目赋予数字 7,当 markdown 呈现时,它将按顺序正确呈现所有数字。

语法高亮

在下面的部分中,我嵌入了来自要点的片段,这是因为 dev.to 编辑器中有一个错误,不允许正确转义反引号。

我在 dev.to 仓库里开了一个 issue。如果有读者想尝试一下,欢迎随时提出!

大多数人都知道用三个反引号包装代码片段,如下所示:

```
someCodeGoes("here")
```
view raw gistfile1.md hosted with ❤ by GitHub

将其呈现为如下代码片段:

someCodeGoes("here")
Enter fullscreen mode Exit fullscreen mode

您可能还知道,可以像这样添加代码所用的语言的名称:

将为您提供如下语法突出显示:

someCodeGoes("here")
Enter fullscreen mode Exit fullscreen mode

但是您是否知道您也可以将其diff作为一种语言,当您这样做时,它将以红色呈现以 开头的任何行,以绿色-呈现以 开头的任何行。+

所以这样:

将呈现如下效果:

    someCodeGoes(here) {
-     oldCode()
+     newCode()
      someMore(code)
    }
Enter fullscreen mode Exit fullscreen mode

我发现这在编写教程时特别有用,因为有些步骤的代码改动很小。读者有时可能很难意识到发生了什么变化,使用 diff 来突出显示差异可以让情况变得容易得多!

转义反引号;并非如此的生活窍门

下一个小窍门涉及如何在 Markdown 中转义反引号和其他保留字符,但由于上一节开头提到的错误,我不得不将其留到下次再讲 :(

如果您想了解它是如何完成的,请查看我上面嵌入的要点,然后单击“原始”按钮查看我是如何做到的。

我希望你发现这些有用!

现在开始编写您一直拖延的文档吧!

文章来源:https://dev.to/yechielk/这些-lifehacks-will-change-the-way-you-write-markdown-3651
PREV
10 个实用的 Git 技巧,助您改善工作流程
NEXT
我最喜欢的 Bash 技巧、窍门和快捷键