如何在GitHub的README.md Markdown文件中创建可点击折叠的目录

实现方案 #

GitHub 原生支持可折叠目录功能，你现有的写法稍作调整就能正常运行，核心是保证 <details> 标签内部的 Markdown 语法能被正确解析。

正确示例代码 #

<!-- 可折叠目录区块 -->
<details>
  <summary>Table of Contents</summary>
  <!-- 这里要空一行，否则GitHub不会解析内部的Markdown链接 -->
  - [Regex](#regex)
  - 你可以按照同样格式添加更多章节链接
</details>

<!-- 正文章节 -->
### Regex
The details will be here...

补充说明 #

• 如果需要目录默认展开，直接给 <details> 标签添加 open 属性即可，写法为 <details open>
• <summary> 标签内的文字可以自定义，你如果用中文README可以改成「点击展开目录」之类的表述
• 章节链接的锚点规则和普通Markdown目录完全一致，多个单词的标题用短横线连接，自动忽略大小写和特殊符号

内容的提问来源于stack exchange，提问作者fsefidabi