是否有可能生成一个自动目录使用Github调味Markdown?
当前回答
现在有一个GitHub行动完成这一点:
https://github.com/marketplace/actions/toc-generator
指定TOC的位置(选项) 例如README.md
<!-- START doctoc -->
<!-- END doctoc -->
设置工作流程 例如.github /工作流/ toc.yml
on: push
name: TOC Generator
jobs:
generateTOC:
name: TOC Generator
runs-on: ubuntu-latest
steps:
- uses: technote-space/toc-generator@v2
其他回答
可以从README中使用http://documentup.com/自动生成一个网页。md文件。它不是创建TOC,但对于许多人来说,它可能解决了想要创建TOC的原因。
Documentup的另一个替代方案是Flatdoc: http://ricostacruz.com/flatdoc/
Gitdown是Github的markdown预处理器。
使用Gitdown你可以:
生成目录 查找失效的url和片段标识符 包括变量 包含文件 获取文件大小 生成徽章 打印日期 打印关于存储库本身的信息
giitdown简化了与维护GitHub存储库文档页面相关的常见任务。
使用它很简单:
var Gitdown = require('gitdown');
Gitdown
// Gitdown flavored markdown.
.read('.gitdown/README.md')
// GitHub compatible markdown.
.write('README.md');
您可以将其作为一个单独的脚本,也可以将其作为构建脚本例程的一部分(例如Gulp)。
大多数其他答案需要安装一些工具。 我找到了一个快速简单的在线解决方案https://imthenachoman.github.io/nGitHubTOC。
对于任何markdown输入,它生成内容输出表。 您可以指定最小和最大标题级别。
源代码位于https://github.com/imthenachoman/nGitHubTOC
GitHub Pages(基本上是Jekyll的包装器)似乎使用了kramdown,它实现了所有Maruku,因此通过atoc属性支持自动生成的目录:
* auto-gen TOC:
{:toc}
第一行只是开始一个无序列表,实际上被丢弃了。
这将使用文档中的头文件生成一组嵌套的无序列表。
注意:这应该适用于GitHub页面,而不是评论或wiki页面中使用的GitHub调味Markdown (GFM)。我想这个问题没有解决办法。
2021年3月更新:GitHub增加了一个官方解决方案
readme现在显示一个ToC,就像你向下滚动它们:
演示:https://github.com/cirosantilli/test-git-web-interface/tree/master/d
它没有在文档中呈现,因为我想要更好的Ctrl + F,但总比没有强。
Also现在也适用于非readme,例如:https://github.com/cirosantilli/test-git-web-interface/blob/master/md.md
他们还添加了一个存储库设置来启用禁用该功能。太奇怪了,谁会想让它失效呢?在https://github.com/cirosantilli/test-git-web-interface/settings下面
目录 自动生成此存储库中Markdown文件的目录。目录将显示在文件顶部附近。
原来的答案
这是不可能的,除了建议的变通办法。
我建议Kramdown TOC扩展和其他可能性support@github.com和Steven!Ragnarök的回复一如既往:
谢谢你的建议和链接。我将把它添加到我们的内部功能请求列表中,供团队查看。
让我们给这个问题投票,直到它发生为止。
另一种解决方法是使用Asciidoc而不是Markdown,后者会渲染toc。现在我的内容已经采用了这种方法。
推荐文章
- 在Markdown Jekyll中使用图像说明
- 如何修改GitHub拉请求?
- 如何在Github和本地删除最后n次提交?
- 如何将文件附加到GitHub问题?
- Slack Markdown链接没有解决
- 如何添加谷歌分析跟踪ID到GitHub页面
- 差异语法突出显示在Github Markdown
- 我如何创建一个文本框的笔记在markdown?
- /dist目录在开源项目中的意义是什么?
- 我如何从现有回购的分支创建一个新的GitHub回购?
- 在git中压缩提交是什么意思?
- 如何在GitHub上找到存储库项目的创建日期?
- 如何设置一个git项目使用外部回购子模块?
- 在Markdown中创建一个没有标题的表
- 强制LF eol在git的回购和工作副本