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

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

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

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

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

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

评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
红包 添加红包
表情包 插入表情
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

17岁boy想当攻城狮

感谢打赏

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值