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

相关推荐
<但凡.1 小时前
Git 完全手册:从入门到团队协作实战(4)
git·bash
SugarPPig2 小时前
Git 创建一个完全没有提交历史的 master 分支
git
lb29171 天前
git的使用,推送仓库github
git·github
躲在云朵里`1 天前
Git的使用
大数据·git·elasticsearch
悟能不能悟1 天前
在 IntelliJ IDEA 中打开这个用于设置 Git 用户名(Name)和邮箱(Email)的特定弹窗
java·git·intellij-idea
rhyme2 天前
源码浅析:SpringBoot main方法结束为什么程序不停止
springboot·markdown·java多线程·源码解析·mermaid
威威猫的栗子2 天前
Git 使用全指南:从配置到免密登录
大数据·git·vscode
Casia_Dominic2 天前
【tmux无法使用鼠标滚轮滚动页面的问题】解决方案
linux·git·github·tmux
Justice link3 天前
Nginx和Apache的区别
git
物联网软硬件开发-轨物科技3 天前
【轨物方案】分布式光伏电站运维升级智能化系列:老电站的数智化重生
运维·人工智能·分布式·git