tonycrane / lab-hypotensor

*WIP* 计算机类实验文档降压宝典（编写规范）

TonyCrane / 鹤翔万里

me ∙ blog ∙ note ∙ bilibili ∙ channel ∙ telegram

 

lab-hypotensor's Issues

建议：MkDocs 引用站内素材的路径写法

问题对应内容：实验文档降压宝典/助教版/重修 Markdown/常见错误用法集锦/这个路径是正确的吗

---

问题描述：

关于站内素材路径如何书写，[](../dir/file/) 这样的写法是否合适值得推敲。在 MkDocs 的更新日志中提到，1.5.0 及以上版本增加了对链接有效性的提示与约束。事实上，如果我们写出 [](../dir/file/) 这样的路径，默认情况下会出现如下提示：

INFO - Doc file 'xxx.md' contains an absolute link '../dir/file/', it was left as is. Did you mean '../dir/file.md'?

当然我们可以通过在 mkdocs.yml 文件中加入以下内容来禁用这样的提示（not recommend）：

validation:
  absolute_links: ignore

但我想 MkDocs 设置这样的建议有其道理所在，所以在此提醒一下作者，建议关注 MkDocs 较新版本中关于站内素材的路径写法的内容，或许会对您有所帮助。