如何链接到降价文件(目录)中包含点(。)或逗号(,)的标题?

时间:2018-12-20 22:58:58

标签: github hyperlink markdown heading readme

在我的Readme.MD降价文件中,我想要创建目录(适用于Github)。 [TOC](由Typora生成)未显示在Github上。它显示为[TOC]。我的某些标题包含点或逗号之类的字符。有什么方法可以链接到这些标题?

我尝试了几乎所有我认为的事情,例如:[app.js File](#app.js-file)[app.js File](#app-js-file)[app.js](#app--js-file)[app.js](#app\.js-file)[app.js](#appjs-file)。什么都没有。

这里是一个例子:

Table of contents:
[app.js](#app-js)
[script.js](#script.js)
[One, two, three](#one,-two,-three)

# app.js File
Some text

# script.js File
Some text

# One, two, three
Some text

P.S。有人在谈论创建HTML锚(命名),但是您如何/在何处将它们写入MD文件(以防万一)。您能解释一下吗(我在互联网上找不到任何解决方案)。

2 个答案:

答案 0 :(得分:2)

问题1

是否可以链接到这些标题(包含标点符号)?

是的。删除所有标点符号,并用连字符代替空格。这适用于Github,但对于其他markdown编辑器(例如hashnode.com),则必须将标点符号替换为连字符。

在上面的示例中,我没有链接完整的标题。这就是为什么有些不起作用的原因。要修正您给出的示例:

Table of contents:
[app.js](#appjs-file)
[script.js](#scriptjs-file)
[One, two, three](#one-two-three)

# app.js File
Some text

# script.js File
Some text

# One, two, three
Some text

问题2

有人在谈论创建HTML锚(命名),但是您如何/在哪里将它们写到MD文件中(如果可以的话)?

您可以在同一行的标题旁边添加HTML锚点。您在目录中提供的链接应与标题中的锚点名称匹配,但应除去哈希值。

这是一个例子:

Table of contents:
[app.js](#app-js-file)
[script.js](#script-js-file)
[One, two, three](#one-two-three)

# app.js File <a name="app-js-file"></a>
Some text

# script.js File <a name="script-js-file"></a>
Some text

# One, two, three <a name="one-two-three"></a>
Some text

Here's a Github Gist来证明它可以在Github上运行。

答案 1 :(得分:1)

如果将鼠标悬停在要链接到呈现内容中的标题上,您应该会看到一个链接图标。将鼠标悬停在该图标上可以查看其链接到的对象,并将其用作目标。我想您会找到名为

的链接
  • appjs-file
  • scriptjs-file
  • one-two-three

This answer指出了一些可能会导致链接命名的逻辑,但我无法确认。

作为一个附带说明,Markdown的设计即使是原始格式也易于阅读。我强烈建议在标题散列和标题文本之间添加一个空格,并在标题及其内容之间添加一个空白行,例如

# app.js File

Some text

某些Markdown处理器将需要其中之一或两者才能正确渲染。