如何在GitHub wiki中创建某种内容表?
如果你看这里: 你会注意到有一个小的“内容”部分,如果你点击其中一个链接,它会将你发送到页面上的特定部分如何在GitHub wiki中创建某种内容表?,github,wiki,Github,Wiki,如果你看这里: 你会注意到有一个小的“内容”部分,如果你点击其中一个链接,它会将你发送到页面上的特定部分 如何在GitHub wiki中实现这一点?通过降价或他们使用的任何东西?这在本手册的目录中得到了很好的演示 目录 [标题](#标题) [强调](#强调) 剪 ##标题 如果您将鼠标悬停在GitHub标记文件的头上,您会看到它左侧有一个简单的小链接,您也可以使用该链接。该链接的格式是一种可能的(半自动)解决方案是Eugene Kalinin的github markdown toc。这个工具基
如何在GitHub wiki中实现这一点?通过降价或他们使用的任何东西?这在本手册的目录中得到了很好的演示
目录
[标题](#标题)
[强调](#强调)
剪
##标题
如果您将鼠标悬停在GitHub标记文件的头上,您会看到它左侧有一个简单的小链接,您也可以使用该链接。该链接的格式是一种可能的(半自动)解决方案是Eugene Kalinin的github markdown toc
。这个工具基本上是通过你的README.md
文件来创建一个TOC,并搜索出
的标题
下载脚本
将您的README.md
输入脚本(如Eugene的README.md
中所述)
cat README.md | bash github降价目录
剪切并粘贴生成的TOC,并将其放置在README.md
文件的顶部
注意,这个bash
实现只在Linux上有效(据我所知)
顺便说一句,这里有一个golang,工作起来可能更麻烦。
git克隆您的repo.wiki.git
(在.git
之前添加.wiki
以克隆wiki
npm i-g降价toc
- 在wiki的标记中插入
(区分大小写)
markdowntoc-i我的wiki markdown.md
(-i
将对其进行适当编辑)
- 利润
更新:我认为现在可能更流行。目前使用标记语法(.md
)来实现这一点。正在对呈现的标记文件进行非官方的更新,如README.md
,其中列出了一些想法
但是,还有一些其他解决办法,例如:
- 根据本文的建议,使用Ascidoc
。例如:
:toc: macro
:toc-title:
:toclevels: 99
# Title
toc::[]
## A
### A2
## B
### B2
请检查位于的示例
您可以选择编辑模式“MediaWiki”,它将为标题生成toc,例如:
== First ==
== Second ==
如果您不能坚持降价,可以执行以下操作:
- 在GitHub/wiki上:将标记切换到。使用
语法。请参阅\uuuuuu-TOC\uuuu
- 在GitHub/repo上:将标记切换到。使用
语法。请参阅:toc:
- 在GitHub/repo上:将标记切换到。使用
语法。内容:
- 当激活Jekyll时,默认情况下它会使用
- Kramdown附带
。使用目录
语法。请参阅{:toc}
由于github有自己的方式在h1、h2、h3等中生成id=“..”属性,因此在处理标记后,html版本中的头文件(例如Bitbucket使用Sluggifing头文件标题到id=“slug”的模式略有不同)很方便,不必重新发明轮子,而是使用反向工程此过程的库 我找到了一个很好的库来完成这个任务,叫做 对我来说,这似乎是最好的解决方案,因为我总是在我的机器上安装node 只需执行npx markdown toc-i file.md即可 它看起来是这项任务中比较流行的工具之一——至少在node.js生态系统中是如此
ls
cat <<EOF >> test.md | tee
## Table of Contents
<!-- toc -->
- old toc 1
- old toc 2
- old toc 3
<!-- tocstop -->
## abc
This is a b c.
## xyz
This is x y z.
EOF
ls
cat test.md
npx markdown-toc -i test.md
cat test.md
ls
cat test.md |三通
##目录
-旧toc 1
-旧toc 2
-旧toc 3
##abc
这是一个b c。
##xyz
这是xyz。
EOF
ls
cat test.md
npx降价toc-i test.md
cat test.md
输出:
因为github不能直接使用
TOC
,但我们还有其他选择
您可以通过在线工具自动生成TOC:
或通过本地工具:
Visual Studio代码
如果您碰巧使用了,有一个名为的易于使用的扩展名,它可以在瞬间为任何.md文件创建TOC
只需打开命令面板(Ctrl-Shift-p
)->标记:创建目录
自动更新会弄乱你编辑的目录吗?
作为附加提示,您可能希望通过使用关闭“保存时自动TOC更新”
“markdown.extension.toc.updateOnSave”:false,
在VisualStudio设置中(命令调色板->首选项:打开设置(JSON))。在Perl顶部实现了一个与TOC标记相关的工具(Linux/Git for Windows always随附,Cygwin随附,并且不依赖额外的包) 我猜我的工具与其他人提到的Ekalin/git markdown toc的工作原理相似或几乎相似。我从来没有比较过tham,因为他的工具是作为Go Lang实现的,在我的系统上不存在。我脚本的主要目标是提供在本地创建toc的好解决方案——没有任何与任何外部主机的连接等等在上,仅读取本地文件(默认情况下为README.md)并创建TOC并将其嵌入文件。您现在(2021年3月)可以查看GitHub首席执行官Nat Friedman GitHub现在会根据标题自动为文件创建目录 经过深思熟虑,我们将此作为查看器的一个特性,而不是编辑的一个问题:无需插入特殊标记 因此…它不会修改标记(
README.md
或其他.md
文件)以插入或更新文本:它只提供一个菜单,允许根据标记标题快速访问测试部分。这可能是,也可能不是,你所追求的 示例:
[Go to Delete](#delete_lines)
#delete_lines
code here, will be pointed here
见:
A
[Go to Delete](#delete_lines)
#delete_lines
code here, will be pointed here
* 1\. [Go to Delete](#delete_lines)
* 1.1\. item
* 1.2\. item
* 1.2\. item
* 2\. item