python - mkdocs:如何附加可下载文件

Question

我有一个类似于以下内容的 mkdocs 项目:

project
├─mkdocs.yml
├─docs
│ ├─home.md
│ ├─chapter1.md
│
├─static
  ├─file.ext
  ├─image.png

我正在尝试找到一种将file1.ext“附加”到构建的方法，例如作为chapter1.md中的链接。

有什么建议可以实现这一目标吗？详细信息:我希望点击即可下载该文件。

Answer 1

在 mkdocs 中，要使用 markdown 单击即可下载文件，首先需要将其添加到 mkdocs.yml文件:

markdown_extensions:
  - attr_list

然后在您的chapter1.md中，您可以将download属性添加到您的链接...就像这样:

[file.ext](../static/file.ext){:download}

你甚至可以给下载的文件命名:

[file.ext](../static/file.ext){:download="awesome-file"}

---

说明

MkDocs 使用 Python-Markdown 将 Markdown 转换为 HTML它提供了灵活的扩展机制，可以更改和/或扩展解析器的行为，而无需编辑实际的源文件。

mkdocs.yml 中的 markdown_extensions 设置指定 MkDocs 的 Python-Markdown 扩展。 添加 attr_list 入口点可启用 Python-Markdown attribute lists 扩展，它使用大括号 {} 和类似 CSS 的语法添加了对 HTML 样式属性的支持。

示例:

假设我们想在新选项卡中打开一个链接，我们可以这样实现:

[Google](https://www.google.com){:target="_blank"}