我正在尝试使用 mkdocs 构建文档。问题是静态创建页面中的链接不起作用。我没有转到 [folder]/index.html,而是显示如下页面,如下图所示
但是,当我尝试 mkdocs 服务时,问题不存在
在您的配置文件中设置use_directory_urls设置:false
mkdocs.yml
use_directory_urls: false
该文档解释说:
此设置控制用于链接到文档中页面的样式。
下表演示了设置
use_directory_urls
为true
或时站点上使用的 URL 有何不同false
。Source file | Generated HTML | use_directory_urls: true | use_directory_urls: false ------------ | -------------------- | ------------------------ | ------------------------ index.md | index.html | / | /index.html api-guide.md | api-guide/index.html | /api-guide/ | /api-guide/index.html about.md | about/index.html | /about/ | /about/index.html
默认样式
use_directory_urls: true
创建更用户友好的 URL,通常是您想要使用的。如果您希望文档在直接从文件系统打开页面时保持正确链接,则备用样式有时会很有用,因为它创建的链接直接指向目标文件而不是目标 目录。
最后一段是为什么这会有所作为的关键。