You need to enable JavaScript to run this app.
优惠活动
大模型
产品
解决方案
定价
更多

如何在MkDocs项目中添加可点击下载的文件链接?

MkDocs 静态文件纳入构建并添加下载链接的方案

方案一:直接迁移文件至 docs 目录

  • 把 static/file.ext 移动或复制到 docs 目录下(可新建子目录如 docs/assets 存放,避免杂乱)
  • 在 chapter1.md 中添加下载链接:[下载文件](assets/file.ext)(路径根据实际存放位置调整)
  • 特点:无需额外配置,MkDocs 默认会构建 docs 下所有文件,操作最简单;但文件较多时会打乱文档目录结构

方案二:通过 mkdocs.yml 配置额外静态文件

  • 编辑项目根目录的 mkdocs.yml,添加 extra_files 配置项,指定要纳入构建的文件或目录:
    # 单个文件配置
    extra_files:
      - static/file.ext
    
    # 整个static目录配置(适合多文件场景)
    extra_files:
      - static/
    
  • 在 chapter1.md 中添加下载链接:[下载文件](../static/file.ext)(路径相对于 docs 目录,需注意层级)
  • 特点:能保持原有目录结构,无需移动文件;但单个文件配置时,新增文件需同步更新配置

方案三:使用静态文件管理插件

  • 安装 MkDocs 静态文件管理插件(如 mkdocs-static-files-plugin),然后在 mkdocs.yml 中配置插件:
    plugins:
      - static-files:
          static_path: static
    
  • 在 chapter1.md 中添加下载链接:[下载文件](static/file.ext)
  • 特点:适合大量静态文件的复杂场景,部分插件支持更多自定义规则;但需要额外安装依赖,增加项目复杂度

内容的提问来源于stack exchange,提问作者deponovo

相关产品推荐
方舟 Agent Plan

超全模态模型 × Harness 升级,最新支持 Deepseek-V4.1-Flash、GLM-5.3 系列、Doubao-Seedream-5.0-pro、Kimi-K3 (部分), 限时 9.9 元起

最近更新时间:2026.07.21 17:30:08