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

一般在编写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解析器就支持锚点解析。

相关推荐
Dontla7 小时前
git bash打开Claude code报错:Claude Code on Windows requires git-bash.(别把git装其他位置,严格按照默认安装)找不到claude code
windows·git·bash
一个梦醒了7 小时前
安装git bash选项推荐
开发语言·git·bash
呆萌的代Ma11 小时前
Git不强行推送,撤销最近几次的提交
git
透明的玻璃杯13 小时前
git应用
git
炸炸鱼.15 小时前
Git+Jenkins实战(一):从零搭建自动化发布与回滚系统(附完整代码)
git·jenkins
言66617 小时前
要忽略前端依赖包node_modules的文件在目录下 git暂存区消失
git
胡小禾18 小时前
Git Worktree
git
程序员小羊!18 小时前
18 GIt
git
怣疯knight18 小时前
Git 本地分支关联远程分支 常用命令汇总
git
ANNENBERG19 小时前
git分支开发管理
git