使用Mkdocs将README设为首页时图片链接失效问题求助
解决Mkdocs图片路径问题的几种简洁方法
统一图片存放位置并配置
extra_dirs
把项目里的docs/img文件夹移到项目根目录(和docs文件夹同级),然后将README.md和docs/index.md里的图片路径改为./img/img1.png。接着在mkdocs.yml中添加配置:extra_dirs: - img这样Mkdocs构建时会自动把根目录的
img文件夹复制到site目录下,两种文件里的图片路径都能正常解析。使用站点根绝对路径
不用移动图片,直接把docs/index.md里的图片路径改成/img/img1.png(以站点根为基准的绝对路径),然后在mkdocs.yml中配置:extra_dirs: - docs/img构建时Mkdocs会把
docs/img复制到site/img,绝对路径就能正确指向图片。自动替换路径的脚本
写个简单脚本,每次复制README.md到docs/index.md时自动替换图片路径。比如用Shell脚本:sed 's/docs\/img\//img\//g' README.md > docs/index.md每次更新README后运行脚本即可,不用手动修改路径。
内容的提问来源于stack exchange,提问作者Mo Kanj
相关产品推荐
相关产品推荐

