是否有可能生成一个自动目录使用Github调味Markdown?
当前回答
在使用Visual Studio Code时,实现mardown文件目录的一个非常方便的方法是扩展名Markdown-TOC。
它可以向现有的markdown文件添加toc,甚至在保存时保持toc的最新状态。
其他回答
我创建了两个选项来生成一个toc的github风味markdown:
DocToc命令行工具(源代码)需要node.js
Installation:NPM install -g doctoc
Usage:doctoc。向当前目录和所有子目录中的所有markdown文件添加目录。
DocToc WebApp
如果你想先在网上试试,去doctoc网站, 粘贴标记页面的链接,它将生成一个表 可以插入标记文件顶部的内容。
Github维基和锚
正如Matthew Flaschen在下面的评论中指出的那样,对于其维基页面,GitHub之前并没有生成doctoc所依赖的锚。
更新:但是,他们修复了这个问题。
Github调味Markdown使用红地毯作为他们的Markdown引擎。 摘自RedCarpet回购:
:with_toc_data -添加HTML锚的每个头在输出HTML, 允许链接到每个部分。
似乎你需要在渲染器级别设置这个标志,这在Github上显然是不可能的。然而,Github Pages的最新更新,似乎自动锚定是为标题打开的,创建可链接的标题。这不是你想要的,但它可能会帮助你更容易地为你的文档创建一个TOC(尽管是手动的)。
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。现在我的内容已经采用了这种方法。
更新2022 - 02年
在VSCode中,检查扩展“Markdown All In One”。自动生成并更新减记的TOC。
安装扩展。 将光标放在您想要插入TOC的位置。 运行命令“Markdown All in One:创建目录” 享受吧!
无耻的“借用”这个SO答案。
你可以用Pandoc做到这一点。
pandoc -s --toc input.md -o input_toc.md
注意:输入和输出文件的顺序在这里很重要。
推荐文章
- 了解Git和GitHub的基础知识
- 在GitHub上有一个公共回购的私人分支?
- 只用GitHub动作在特定分支上运行作业
- Git合并与强制覆盖
- 是否有一个链接到GitHub下载文件的最新版本的存储库?
- GitHub -致命:无法读取用户名https://github.com':没有这样的文件或目录
- Github:我能看到回购的下载数量吗?
- 如何运行一个github-actions步骤,即使前一步失败,同时仍然失败的工作
- 当我试图推到原点时,为什么Git告诉我“没有这样的远程‘原点’”?
- 在GitHub repo上显示Jenkins构建的当前状态
- 如何取消在github上的拉请求?
- HEAD和master的区别
- 在另一个目录中运行操作
- GitHub克隆与OAuth访问令牌
- 我可以在GitHub上对要点进行拉请求吗?