TypeDoc项目:自定义侧边栏模块排序方法详解
2025-05-28 01:02:05作者:邵娇湘
在TypeDoc文档生成工具的使用过程中,开发者经常需要对生成的文档侧边栏进行自定义排序。本文将详细介绍如何控制TypeDoc生成的文档中侧边栏模块的显示顺序。
默认排序行为
TypeDoc默认会对入口点(entry points)进行自动排序,这种排序通常是基于字母顺序的。虽然这种默认行为对大多数项目已经足够,但在某些特定场景下,开发者可能希望手动控制模块的显示顺序。
自定义排序解决方案
TypeDoc提供了一个名为sortEntryPoints的配置选项,专门用于控制入口点的排序行为。当这个选项被设置为false时,TypeDoc将保持你在配置文件中指定的入口点顺序,而不会进行任何自动排序。
实现方法
要使用自定义排序,只需在TypeDoc的配置文件中进行如下设置:
{
"sortEntryPoints": false,
"entryPoints": [
"src/core",
"src/utils",
"src/models",
"src/services"
]
}
通过这种方式,TypeDoc生成的文档侧边栏将严格按照配置文件中entryPoints数组的顺序来显示各个模块。
适用场景
这种自定义排序特别适合以下情况:
- 项目有特定的模块依赖关系需要强调
- 希望将核心模块或重要模块放在更显眼的位置
- 需要遵循公司或团队的文档规范
- 项目模块之间存在逻辑顺序关系
注意事项
- 当sortEntryPoints设置为false时,确保entryPoints数组中的顺序确实是你想要的最终顺序
- 这个设置只影响顶级模块的排序,不影响模块内部成员的排序
- 如果项目结构发生变化,需要手动更新entryPoints的顺序
通过合理利用sortEntryPoints选项,开发者可以完全掌控TypeDoc生成的文档结构,创建出更符合项目需求和团队规范的API文档。
登录后查看全文
热门项目推荐
相关项目推荐
Kimi-K2.5Kimi K2.5 是一款开源的原生多模态智能体模型,它在 Kimi-K2-Base 的基础上,通过对约 15 万亿混合视觉和文本 tokens 进行持续预训练构建而成。该模型将视觉与语言理解、高级智能体能力、即时模式与思考模式,以及对话式与智能体范式无缝融合。Python00
GLM-4.7-FlashGLM-4.7-Flash 是一款 30B-A3B MoE 模型。作为 30B 级别中的佼佼者,GLM-4.7-Flash 为追求性能与效率平衡的轻量化部署提供了全新选择。Jinja00
VLOOKVLOOK™ 是优雅好用的 Typora/Markdown 主题包和增强插件。 VLOOK™ is an elegant and practical THEME PACKAGE × ENHANCEMENT PLUGIN for Typora/Markdown.Less00
PaddleOCR-VL-1.5PaddleOCR-VL-1.5 是 PaddleOCR-VL 的新一代进阶模型,在 OmniDocBench v1.5 上实现了 94.5% 的全新 state-of-the-art 准确率。 为了严格评估模型在真实物理畸变下的鲁棒性——包括扫描伪影、倾斜、扭曲、屏幕拍摄和光照变化——我们提出了 Real5-OmniDocBench 基准测试集。实验结果表明,该增强模型在新构建的基准测试集上达到了 SOTA 性能。此外,我们通过整合印章识别和文本检测识别(text spotting)任务扩展了模型的能力,同时保持 0.9B 的超紧凑 VLM 规模,具备高效率特性。Python00
KuiklyUI基于KMP技术的高性能、全平台开发框架,具备统一代码库、极致易用性和动态灵活性。 Provide a high-performance, full-platform development framework with unified codebase, ultimate ease of use, and dynamic flexibility. 注意:本仓库为Github仓库镜像,PR或Issue请移步至Github发起,感谢支持!Kotlin07
compass-metrics-modelMetrics model project for the OSS CompassPython00
项目优选
收起
deepin linux kernel
C
27
11
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
523
3.72 K
Ascend Extension for PyTorch
Python
329
388
本项目是CANN提供的数学类基础计算算子库,实现网络在NPU上加速计算。
C++
877
578
openEuler内核是openEuler操作系统的核心,既是系统性能与稳定性的基石,也是连接处理器、设备与服务的桥梁。
C
335
161
暂无简介
Dart
762
188
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
1.33 K
745
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
12
1
React Native鸿蒙化仓库
JavaScript
302
349
华为昇腾面向大规模分布式训练的多模态大模型套件,支撑多模态生成、多模态理解。
Python
113
136