在 Github 中对 Markdown 文档进行脚注的方法

Github 中进行脚注的方法

在 GitHub Flavored Markdown 中,没有原生支持脚注,我们可以使用如下方法曲线救国来进行脚注。

  1. 首先以如下方式在底部定义脚注:
    ```
    <a name="脚注1">1</a>: 此处填写脚注内容
    ```
  2. 然后在文档中的需要引用脚注的地方添加如下内容:
    ```
    <sup>[1](#脚注1)</sup>
    ```

此方法可以正确实现效果:脚注引用上标显示,脚注链接可点击、可跳转。

通用的 Markdown 脚注方法

在平时的 Markdown 写作中,有时我们需要进行脚注,可以采用以下两种方法进行。

方法一

使用如下方式进行脚注的添加:

需要添加脚注的文本一。[^1]

[^1]: 方法一的脚注
  • 这种方法使文本与脚注分离,好处是撰写方式与显示效果一致,在脚注较多时也比较易于整理。
  • 此方法适用性更强,常见的 Markdown 解释器可使用该方法。

方法二

使用如下方式进行脚注的添加:

需要添加脚注的文本二。^[方法二的脚注]
  • 这种方式可以直接把脚注内容跟在文本后,好处是撰写文章时可读性更强,且脚注内容会自动显示在文末。
  • 此方法在一些 Markdown 解释器中可能不被识别。

发表评论