有没有可能以一种既满足Github又满足Doxygen的方式编写Markdown链接？

Question

我的项目当前的目录结构是<ProjectRooot>/wiki，并且在wiki目录下有三个Markdown文件。

其中一个文件链接到其他两个文件，我已经尝试了两种编写链接的方式。

第一种方式

[Kernel API & Core Negotiation Protocol](wiki/KernelAPI.md)
[Priorities & Starvation](wiki/Priorities.md)

第二种方法

[Kernel API & Core Negotiation Protocol](KernelAPI.md)
[Priorities & Starvation](Priorities.md)

在第一种方法下，在生成的Doxygen中，链接可以正常运行，但在github.com上访问时会出现错误。在第二种方法下，链接可以在github.com上正确运行，但Doxygen根本不尝试进行任何链接。

有没有一种方法可以编写链接，既能满足在两个平台上都能正常工作？

- merlin2011

---

你尝试过绝对URL了吗？换句话说，你的URL路径是从根目录开始的：/wiki/KernelAPI.md。注意开头的斜杠。这可能行不通，但至少可以试试。 - Waylan

是的，我做了。Doxygen拒绝了它。 - merlin2011

Answer 1

有没有一种方法可以编写链接，以满足两者的要求？

不，但你可以：

- 编写适用于 GitHub 的代码（GFM：GitHub Flavored Markdown） - 设置本地 内容过滤驱动程序（在 .gitattributes 文件 中的污点脚本），它将在 git checkout 时将这些链接转换为与 Doxygen 兼容的链接。

^{（图片来自 "Customizing Git - Git Attributes"，来自 "Pro Git book"）}

- VonC

---

我会尝试这个。如果写得正确，我认为git diff不应该显示任何差异？ - merlin2011

@merlin2011 是的，如果您编写了能够恢复原始内容的干净脚本。 - VonC

我在 localhost 上测试过了，但是现在我需要和别人协作。看起来需要一个额外的hack，需要使用全新的克隆才能让其他人也能正常工作（而不仅仅是要求他们拉取 repo）。因此，我可能不会使用这个解决方案，因为如果有人尝试生成文档并实现不正确，Doxygen 中的链接将会断开。不过还是谢谢你教给我的东西！ - merlin2011

@merlin2011 是的，需要在本地激活内容过滤驱动程序（一次）。 - VonC