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-w4a8GLM-5-w4a8基于混合专家架构,专为复杂系统工程与长周期智能体任务设计。支持单/多节点部署,适配Atlas 800T A3,采用w4a8量化技术,结合vLLM推理优化,高效平衡性能与精度,助力智能应用开发Jinja00
jiuwenclawJiuwenClaw 是一款基于openJiuwen开发的智能AI Agent,它能够将大语言模型的强大能力,通过你日常使用的各类通讯应用,直接延伸至你的指尖。Python0194- QQwen3.5-397B-A17BQwen3.5 实现了重大飞跃,整合了多模态学习、架构效率、强化学习规模以及全球可访问性等方面的突破性进展,旨在为开发者和企业赋予前所未有的能力与效率。Jinja00
AtomGit城市坐标计划AtomGit 城市坐标计划开启!让开源有坐标,让城市有星火。致力于与城市合伙人共同构建并长期运营一个健康、活跃的本地开发者生态。01
awesome-zig一个关于 Zig 优秀库及资源的协作列表。Makefile00
项目优选
收起
deepin linux kernel
C
27
12
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
602
4.04 K
🔥LeetCode solutions in any programming language | 多种编程语言实现 LeetCode、《剑指 Offer(第 2 版)》、《程序员面试金典(第 6 版)》题解
Java
69
21
暂无简介
Dart
847
204
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
1.46 K
826
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
12
1
喝着茶写代码!最易用的自托管一站式代码托管平台,包含Git托管,代码审查,团队协作,软件包和CI/CD。
Go
24
0
本项目是CANN提供的数学类基础计算算子库,实现网络在NPU上加速计算。
C++
922
770
🎉 基于Spring Boot、Spring Cloud & Alibaba、Vue3 & Vite、Element Plus的分布式前后端分离微服务架构权限管理系统
Vue
234
152
昇腾LLM分布式训练框架
Python
130
156