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的完整布局切换方案。
在实际项目中,可以根据文档结构的特点灵活选择这两种方法。对于多层级文档系统,通常建议在根目录页面禁用目录树,而在子目录页面保持目录树的显示,以提供良好的导航体验。这种混合使用的方式能够兼顾美观性和功能性。
通过合理配置这些元数据,开发者可以打造出既美观又实用的技术文档网站,满足不同场景下的展示需求。
登录后查看全文
热门项目推荐
相关项目推荐
atomcodeClaude Code 的开源替代方案。连接任意大模型,编辑代码,运行命令,自动验证 — 全自动执行。用 Rust 构建,极致性能。 | An open-source alternative to Claude Code. Connect any LLM, edit code, run commands, and verify changes — autonomously. Built in Rust for speed. Get StartedRust0214
cann-learning-hubCANN 学习中心仓,支持在线互动运行、边学边练,提供教程、示例与优化方案,一站式助力昇腾开发者快速上手。Jupyter Notebook0138
uni-appA cross-platform framework using Vue.jsJavaScript08
GLM-5.2智谱开源 GLM-5.2,这是针对长文本任务的最新旗舰模型。相较于前代产品 GLM-5.1,它在长文本任务处理能力上实现了显著飞跃,并且首次在稳定的 100 万 token 上下文中提供这一能力。Jinja00
SwanLab⚡️SwanLab - an open-source, modern-design AI training tracking and visualization tool. Supports Cloud / Self-hosted use. Integrated with PyTorch / Transformers / LLaMA Factory / veRL/ Swift / Ultralytics / MMEngine / Keras etc.Python00
tiny-universe《大模型白盒子构建指南》:一个全手搓的Tiny-UniverseJupyter Notebook03
项目优选
收起
deepin linux kernel
C
32
16
openEuler内核是openEuler操作系统的核心,既是系统性能与稳定性的基石,也是连接处理器、设备与服务的桥梁。
C
469
465
暂无描述
Dockerfile
778
5.08 K
本项目是CANN提供的transformer类大模型算子库,实现网络在NPU上加速计算。
C++
877
2.03 K
Ascend Extension for PyTorch
Python
758
968
本项目是CANN提供的神经网络类计算算子库,实现网络在NPU上加速计算。
C++
697
1.4 K
昇腾LLM分布式训练框架
Python
185
231
本项目是CANN提供的数学类基础计算算子库,实现网络在NPU上加速计算。
C++
1.1 K
1.14 K
本仓库是 Flutter SDK 与 Flutter Engine 的 OpenHarmony 适配版本,由 CPF-Flutter 团队维护。开发者可使用熟悉的 Flutter 技术栈开发 OpenHarmony 应用,3.35.7 及以后的适配版本可基于本仓库源码构建支持 OpenHarmony 的 Flutter Engine。
Dart
1.04 K
271
JiuwenSwarm 是一款基于openJiuwen开发的智能AI Agent,它能够将大语言模型的强大能力,通过你日常使用的各类通讯应用,直接延伸至你的指尖。
Python
2.25 K
677