MKDOCS - 如何根据内容中找到的关键字启用超链接?

时间:2018-01-09 17:04:39

标签: plugins mkdocs

我正在使用MkDocs,问题是 - 我明白在文档文件中我可以说: [My Link Name](My link URL)

但是,当我想更改导航或更改关键字时,这就是一种喧嚣。

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

提前致谢!

2 个答案:

答案 0 :(得分:0)

您所描述的似乎是interwiki links的原始形式。您可以使用一个插件:markdown extra

您可以在mkdocs.yaml文件中定义维基链接或维基链接组件,例如:

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

然后,您将使用“胡子”表示法:

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

这等同于:

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

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

答案 1 :(得分:0)

请注意,如果您只想在单个Web域中建立链接,则MkDocs支持python-markdown的标准extensions,因此也支持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

免责声明:我还没有尝试过,因此欢迎任何有经验的人来纠正我。