DocFX现代模板中隐藏左侧目录树的配置方法
2025-06-14 12:02:27作者:宣海椒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的完整布局切换方案。
在实际项目中,可以根据文档结构的特点灵活选择这两种方法。对于多层级文档系统,通常建议在根目录页面禁用目录树,而在子目录页面保持目录树的显示,以提供良好的导航体验。这种混合使用的方式能够兼顾美观性和功能性。
通过合理配置这些元数据,开发者可以打造出既美观又实用的技术文档网站,满足不同场景下的展示需求。
登录后查看全文
热门项目推荐
相关项目推荐
GLM-5智谱 AI 正式发布 GLM-5,旨在应对复杂系统工程和长时域智能体任务。Jinja00
GLM-5.1GLM-5.1是智谱迄今最智能的旗舰模型,也是目前全球最强的开源模型。GLM-5.1大大提高了代码能力,在完成长程任务方面提升尤为显著。和此前分钟级交互的模型不同,它能够在一次任务中独立、持续工作超过8小时,期间自主规划、执行、自我进化,最终交付完整的工程级成果。Jinja00
LongCat-AudioDiT-1BLongCat-AudioDiT 是一款基于扩散模型的文本转语音(TTS)模型,代表了当前该领域的最高水平(SOTA),它直接在波形潜空间中进行操作。00- QQwen3.5-397B-A17BQwen3.5 实现了重大飞跃,整合了多模态学习、架构效率、强化学习规模以及全球可访问性等方面的突破性进展,旨在为开发者和企业赋予前所未有的能力与效率。Jinja00
HY-Embodied-0.5这是一套专为现实世界具身智能打造的基础模型。该系列模型采用创新的混合Transformer(Mixture-of-Transformers, MoT) 架构,通过潜在令牌实现模态特异性计算,显著提升了细粒度感知能力。Jinja00
FreeSql功能强大的对象关系映射(O/RM)组件,支持 .NET Core 2.1+、.NET Framework 4.0+、Xamarin 以及 AOT。C#00
项目优选
收起
deepin linux kernel
C
27
14
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
659
4.26 K
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
1.54 K
894
Ascend Extension for PyTorch
Python
503
609
openEuler内核是openEuler操作系统的核心,既是系统性能与稳定性的基石,也是连接处理器、设备与服务的桥梁。
C
391
286
暂无简介
Dart
905
218
🔥LeetCode solutions in any programming language | 多种编程语言实现 LeetCode、《剑指 Offer(第 2 版)》、《程序员面试金典(第 6 版)》题解
Java
69
21
昇腾LLM分布式训练框架
Python
142
168
本项目是CANN提供的数学类基础计算算子库,实现网络在NPU上加速计算。
C++
939
862
🍒 Cherry Studio 是一款支持多个 LLM 提供商的桌面客户端
TypeScript
1.33 K
108