plugins - MKDOCS - 如何根据内容中的关键字启用超链接？

Question

我正在使用MkDocs，我的问题是 - 我知道在文档文件中我可以说： [My Link Name](My link URL)

但是当我想改变我的导航或改变我的关键词时，这真是太麻烦了。

任何人都可以建议一个插件 - 在构建文档时，自动查找与mkdocs.yml文件中的关键字匹配的关键字并创建指向它们的超链接。

提前致谢！

Answer 1

请注意，如果您只想在单个 Web 域中建立链接，MkDocs 支持 python-markdown 的标准扩展，因此也支持 WikiLinks。

md 文件中的语法是“双括号”：

Link to this [[full description]]

哪个会变成=>https://your.website.com/foo/bar/full_description.html

根据文档，您需要做的是在您的 mkdocs.yml 文件中指定：

markdown_extensions:
    - wikilinks:
      - base_url: https://your.website.com/foo/bar/
      - end_url: .html

免责声明：我还没有尝试过，所以欢迎任何有过的人纠正我。

Answer 2

您所描述的似乎是跨维基链接的原始形式。您可以使用一个插件：markdown extra。

您可以在文件中定义您的 wikilinks 或 wikilinks 组件mkdocs.yaml，如下所示，例如：

extra:
  interwiki:
    stackoverflow: stackoverflow.com/questions/
    google: https://www.google.com/search?q=

然后你会使用“mustache”符号：

Please refer to the [question on StackOverflow]({{ interwiki.stackoverflow }}48173267)

这相当于：

Please refer to the [question on StackOverflow](stackoverflow.com/questions/48173267)

我还没有尝试过，但这就是要点。让我知道。

Answer 3

有一种简单的方法可以使用mkdocs-ezlinks-plugin将 wikilinks 添加到 mkdocs 。

安装插件：

pip3 install mkdocs-ezlinks-plugin

请注意，您的操作系统可能更pip喜欢pip3

将以下内容添加到mkdocs.yml：

plugins:
  - search
  - ezlinks:
      wikilinks: true

该插件对链接进行了一些非常好的翻译，并在文档树中搜索匹配的标题。

关联	翻译
[[Page Name]]	[Page Name](../folder2/page-name.md)
![[Puppy]]	
[[Page Name|Link Text]]	[Link Text](../folder2/page-name.md)
[[Page Name#Section Heading|Link Text]]	[Link Text](../folder2/page-name.md#section-heading)