我需要生成一个长
README.md
文件和一些指向不同部分的链接,例如开头的目录。 Markdown 将章节标题翻译成链接:
为了生成目录的链接,我需要锚点的值。我有的文字。我需要规则的片段。大概是这样的:
[This is a heading and a link in Markdown](#thisisaheadingandalinkinmarkdown)
有谁知道如何将 markdown 中的标题转换为锚点/片段值的规则?
GitLab 文档 说明了它如何从降价标头创建锚点:
- 所有文字转为小写
- 删除所有非单词文本(例如标点符号、HTML)
- 所有空格都转换为连字符
- 连续的两个或多个连字符转换为一个
- 如果已经生成了具有相同ID的header,一个唯一的 附加递增数字,从 1 开始。
这意味着
# Standard markdown
的锚点将转换为standard-markdown
虽然我找不到任何明确的规则,但关于 GitHub 如何生成其锚点,似乎通过检查一些
README.md
上面的大多数规则也适用于 GitHub。
我发现在 markdown header rules 中,从之前的注释中对这些进行了调整。
1.所有文字转为小写
2.所有非单词文本(例如标点符号、HTML)不被删除但转换为连字符
3.所有空格都转换为连字符
4.连续两个或多个连字符转换为一个
5.如果已经生成了具有相同ID的header,则附加一个唯一的递增数字,从1开始。
所以,
SEND EMAIL TO DBA'S - is created like this: * [5. SEND EMAIL TO DBA'S]
(#5-send-email-to-dba-s).是否可以强制他们使用我自己的 id 而不是自动生成功能? 任何旁路想法?