首页
/ 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的完整布局切换方案。

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

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

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

项目优选

收起
kernelkernel
deepin linux kernel
C
22
6
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
192
270
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
909
541
Cangjie-ExamplesCangjie-Examples
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
341
1.21 K
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
142
188
nop-entropynop-entropy
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
8
0
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
377
387
金融AI编程实战金融AI编程实战
为非计算机科班出身 (例如财经类高校金融学院) 同学量身定制,新手友好,让学生以亲身实践开源开发的方式,学会使用计算机自动化自己的科研/创新工作。案例以量化投资为主线,涉及 Bash、Python、SQL、BI、AI 等全技术栈,培养面向未来的数智化人才 (如数据工程师、数据分析师、数据科学家、数据决策者、量化投资人)。
Jupyter Notebook
63
58
CangjieCommunityCangjieCommunity
为仓颉编程语言开发者打造活跃、开放、高质量的社区环境
Markdown
1.1 K
0
note-gennote-gen
一款跨平台的 Markdown AI 笔记软件,致力于使用 AI 建立记录和写作的桥梁。
TSX
87
4