mkdocs-material 的 Instant Navigation 功能坑点

mkdocs-material 的 Instant Navigation 功能坑点

💡 原文中文,约3600字,阅读约需9分钟。
📝

内容提要

mkdocs-material的Instant Navigation功能在使用时遇到了一些问题。首先,线上部署时无法正常工作,需要配置site_url才能生成sitemap.xml的内容。其次,点击WaveDrom页面后,WaveDrom代码无法渲染出来。解决方法包括修改mkdocs-material代码、使用其他标签替代< script>标签以及提前渲染WaveDrom到svg。为了使Instant Navigation功能正常工作,需要设置site_url、保证sitemap正常生成,并避免出现非javascript的< script>标签。

🎯

关键要点

  • mkdocs-material的Instant Navigation功能可以提升用户体验,但使用时存在问题。
  • 线上部署时,Instant Navigation功能无法正常工作,需要配置site_url以生成sitemap.xml。
  • sitemap.xml为空的原因是未配置site_url,添加后仍需清除session storage中的缓存才能正常工作。
  • 点击WaveDrom页面时,WaveDrom代码未渲染,因Instant Navigation未考虑<script>标签的type属性。
  • 解决WaveDrom渲染问题的方法包括修改mkdocs-material代码、使用其他标签或提前渲染为svg。
  • 类似的,Arithmatex扩展也会生成<script>标签,解决方案已在mkdocs-material文档中提供。
  • 确保Instant Navigation功能正常工作需要设置site_url,确保sitemap生成,并避免非javascript的<script>标签。
➡️

继续阅读