当前位置: 首页 > news >正文

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

相关文章:

  • 【LLM】Llama Factory:Windows部署全流程
  • linux如何查看系统版本
  • WinDbg. From A to Z! 笔记(一)
  • 项目代码第8讲【数据库基础知识】:SQL(DDL、DML、DQL、DCL);函数(聚合、字符串、数值、日期、流程);约束;多表查询;事务
  • 西域平台商品详情接口设计与实现‌
  • 电容式电压互感器在线监测系统
  • Uni-app入门到精通:tabBar节点实现多页面的切换
  • Open GL ES ->模型矩阵、视图矩阵、投影矩阵等变换矩阵数学推导以及方法接口说明
  • 深入解析 JSON-RPC:从基础到高级应用
  • VUE3+VITE 爬坑笔记
  • 判断质数及其优化方法
  • FTP文件传输协议
  • 【redis】数据类型之Stream
  • Java多线程与高并发专题—— CyclicBarrier 和 CountDownLatch 有什么异同?
  • python面试-基础
  • Android系统启动流程学习(四)应用程序进程启动过程
  • MySQL Binlog
  • 解析 HTML 网站架构规范
  • 使用crontab 每两分钟执行一次 进入 /var/xxx 执行 git pull
  • 开发DOM更新算法
  • 微博:严厉打击对肖某董某事件蹭炒热点、编造故事博流量等行为
  • 奔驰一季度利润降四成,受美国加征关税影响放弃全年盈利展望
  • 百年传承,再启新程,参天中国迎来2.0时代
  • 住房和城乡建设部办公厅主任李晓龙已任部总工程师
  • 年轻人的事业!6家上海人工智能企业畅想“模范生”新征程
  • 如何反击右翼思潮、弥合社会分裂:加拿大大选镜鉴