在Git仓库的Readme上增加目录页

17岁boy想当攻城狮2025-03-31 23:48

一般在编写Readme时想要增加像文章那样的目录，方便快速跳转，但是Markdown语法并没有提供这样的方法，但是可以通过超链接结合锚点的方式来实现，如下图是我之前一个项目里写的Readme：

例如有下面几个Readme内容：

markdown 复制代码

## What is Embedded AI FDK?
test text
## Embedded
test text
## Embedded computing efficiency (Tensor Flow Lite)
test text

通过超链接将地址指向锚点就可以实现目录跳转功能：

markdown 复制代码

- [What is Embedded AI FDK?](#what-is-embedded-ai-fdk)
- [Embedded](#embedded)
- [Singlechip](#singlechip)

这里我为了美观使用了-符号创建了无序列表，需要值得注意的是锚点的格式一般是小写字符没有空格，空格以-替代，并且需要解析软件支持锚点解析，例如Git仓库的Readme解析器就支持锚点解析。