在 GitHub wiki 中,有没有简单的方法可以链接到标题中带有破折号的页面?
我正在向 GitHub wiki 添加我编写的 PowerShell 模块的参考页面。模块中的函数名称遵循 PowerShell 命名约定,因此名称中都包含破折号(连字符),类似于
Set-LogConfiguration
。
我想在 GitHub wiki 中为每个函数创建一个手册页。我可以毫无问题地创建标题为“Set-LogConfiguration”的页面。但是,我无法创建这些页面的内部链接。
我尝试过以下方法:
[[Set-LogConfiguration]]
[[Set\-LogConfiguration]]
[[Set LogConfiguration]]
[[Set%2DLogConfiguration]]
这些都不起作用。在每种情况下,GitHub wiki 都指示链接到的页面不存在。
当我保存带有类似链接的页面时
[[Set-LogConfiguration]]
然后点击链接,它会弹出“创建新页面”屏幕,创建一个页面
Set LogConfiguration
(注意“Set”和“LogConfiguration”之间的空格,而不是破折号)。网址将是
https://github.com/<my repo>/wiki/Set-LogConfiguration
如果我直接创建标题为“Set-LogConfiguration”的页面,它似乎会创建一个与从链接创建的页面具有相同 URL 的页面,但它们是两个不同的页面。
经过多次实验,我找到了如何链接到标题中带有破折号(连字符)的页面:
步骤 | 行动 | 注释 |
---|---|---|
1 | 单击“新建页面”按钮,直接创建标题中带有破折号的页面。 | 请勿通过在另一个页面上添加链接,然后单击该链接来创建页面来创建页面。这将创建标题中没有破折号的页面。例如,点击链接 将创建一个 URL 为 的页面,但页面标题为 ,不带破折号。 |
2 | 创建要链接到的页面后,请转到浏览器的地址栏并从 URL 中复制页面标题。 | 例如,如果 URL 为 ,请复制 URL 的 部分。GitHub wiki 似乎将页面标题中的破折号替换为 URL 中的十六进制值 ,尽管这些值会在浏览器地址栏中呈现为破折号(偷偷摸摸的!)。从地址栏中复制页面标题将拾取十六进制字符。 |
3 | 编辑要添加链接的页面。在要添加链接的位置,粘贴从 URL 复制的页面标题,然后用双方括号括起来,类似于 。 |
在上面的示例中,链接将为 。请勿手动输入页面标题。粘贴从 URL 复制的页面标题。在浏览器中,您粘贴的文本将显示为普通文本,包括页面标题中的破折号。然而,实际上它将包含这三个十六进制值。 |
上述过程不会花费太长时间,并且会给您一个标题中带有破折号的页面以及指向该页面的链接。
唯一的问题是,随后编辑带有链接的页面的任何人都不会意识到该链接包含特殊字符,因为它看起来像普通的破折号(连字符)。有人很容易通过编辑链接来破坏链接,将看起来像破折号的特殊字符替换为真正的破折号。