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

相关推荐
减瓦13 小时前
Windows 环境使用 Git Bash 最佳实践
windows·git
史呆芬14 小时前
CodeX多仓库提交Skill搭建
git·后端·openai
城东15 小时前
Git使用[原意要新建分支提交但是误提交到原来分支恢复办法]
git·原意要新建分支提交·但是误提交到原来分支
开发者联盟league15 小时前
git 压缩本地最近多个commit
git
赵庆明老师1 天前
Vben精讲:04-了解VSCode中的Git
ide·git·vscode
Irissgwe1 天前
第 5 篇:Git 分支基础:branch、checkout、merge 和冲突解决
git
liberalhumblehopeful1 天前
git代码管理-分支差距过大如何进行同步
git
一只楚楚猫2 天前
一篇文章入门Git工具
git
Irissgwe2 天前
第 6 篇:Git 分支进阶:分支策略、stash、bugfix 和 feature 开发
git