如何配置Material for MkDocs以支持符号链接指向的文档构建?
如何配置Material for MkDocs以支持符号链接指向的文档构建?
看起来你碰到的是MkDocs默认不处理符号链接的问题,我给你几个实用的解决思路:
先确认符号链接本身没问题
首先得检查你创建的符号链接是不是真的指向了正确的目标路径,毕竟如果链接本身无效,MkDocs肯定找不到文件。你可以用这个命令查看:ls -l docs/first_project_guide看看输出里的目标路径(比如
/home/user/projects/first_project/Guide)是否真实存在,而且当前运行MkDocs的用户有没有读取这个文件夹的权限。要是路径不存在或者权限不够,就会触发你看到的FileNotFoundError。修改MkDocs配置,永久启用符号链接跟随
MkDocs本身是支持处理符号链接的,只是默认没打开这个功能。你只需要在项目根目录的mkdocs.yml配置文件里加上这一行:follow_symlinks: true保存配置后,不管是用
mkdocs build构建静态文件,还是用mkdocs serve本地预览,MkDocs都会自动跟随符号链接,读取链接指向的文件夹里的文档内容。临时通过命令行参数启用(按需选择)
要是你不想修改全局配置,也可以每次运行MkDocs命令时手动加上--follow-symlinks参数,比如:# 本地预览时启用 mkdocs serve --follow-symlinks # 构建静态文件时启用 mkdocs build --follow-symlinks这个参数会临时让本次构建/预览过程跟随符号链接,不用改动配置文件。
还有个小提醒:如果符号链接指向的是Git仓库里的文件夹,要确保那个仓库已经把Guide文件夹里的文件都正确检出了(不是空文件夹),不然MkDocs还是会找不到内容哦。
备注:内容来源于stack exchange,提问作者icedwater
相关产品推荐
相关产品推荐

