首页
/ DocFX现代模板中隐藏左侧目录树的配置方法

DocFX现代模板中隐藏左侧目录树的配置方法

2025-06-14 05:46:19作者:宣海椒Queenly

在使用DocFX构建技术文档时,现代模板(modern template)默认会在页面左侧显示目录树(TOC)。但在某些场景下,特别是文档根目录的首页(index.html)中,这个设计可能会影响页面美观性和用户体验。本文将介绍两种有效控制目录树显示的方法。

方法一:使用_layout元数据

通过为特定页面添加_layout: landing元数据,可以同时隐藏左侧目录树和右侧的Affix导航区域。这种方法适用于需要简洁展示的落地页场景。

在Markdown文件头部添加以下元数据:

---
_layout: landing
---

这个配置会完全移除页面的导航元素,使页面呈现为纯粹的展示型布局。需要注意的是,这种方法会同时影响多个导航元素,适合对页面布局有整体性调整需求的场景。

方法二:使用_disableToc元数据(DocFX 2.76+)

从DocFX 2.76.0版本开始,新增了_disableToc元数据支持,可以单独控制目录树的显示。这种方法更加精细,只影响目录树而不改变其他导航元素。

在Markdown文件头部添加:

---
_disableToc: true
---

这个配置特别适合需要保留右侧Affix导航,但只需要隐藏左侧目录树的场景。新版本的这个特性使现代模板的目录显示行为与默认模板(default template)保持一致,提供了更好的灵活性。

版本兼容性说明

对于使用较旧版本DocFX(如2.73.2)的用户,建议优先考虑升级到2.76.0或更高版本,以获得更完善的目录控制功能。如果因特殊原因无法升级,则只能使用_layout: landing的完整布局切换方案。

在实际项目中,可以根据文档结构的特点灵活选择这两种方法。对于多层级文档系统,通常建议在根目录页面禁用目录树,而在子目录页面保持目录树的显示,以提供良好的导航体验。这种混合使用的方式能够兼顾美观性和功能性。

通过合理配置这些元数据,开发者可以打造出既美观又实用的技术文档网站,满足不同场景下的展示需求。

登录后查看全文
热门项目推荐
相关项目推荐