首页
/ TypeDoc项目:自定义侧边栏模块排序方法详解

TypeDoc项目:自定义侧边栏模块排序方法详解

2025-05-28 17:14:44作者:邵娇湘

在TypeDoc文档生成工具的使用过程中,开发者经常需要对生成的文档侧边栏进行自定义排序。本文将详细介绍如何控制TypeDoc生成的文档中侧边栏模块的显示顺序。

默认排序行为

TypeDoc默认会对入口点(entry points)进行自动排序,这种排序通常是基于字母顺序的。虽然这种默认行为对大多数项目已经足够,但在某些特定场景下,开发者可能希望手动控制模块的显示顺序。

自定义排序解决方案

TypeDoc提供了一个名为sortEntryPoints的配置选项,专门用于控制入口点的排序行为。当这个选项被设置为false时,TypeDoc将保持你在配置文件中指定的入口点顺序,而不会进行任何自动排序。

实现方法

要使用自定义排序,只需在TypeDoc的配置文件中进行如下设置:

{
  "sortEntryPoints": false,
  "entryPoints": [
    "src/core",
    "src/utils",
    "src/models",
    "src/services"
  ]
}

通过这种方式,TypeDoc生成的文档侧边栏将严格按照配置文件中entryPoints数组的顺序来显示各个模块。

适用场景

这种自定义排序特别适合以下情况:

  • 项目有特定的模块依赖关系需要强调
  • 希望将核心模块或重要模块放在更显眼的位置
  • 需要遵循公司或团队的文档规范
  • 项目模块之间存在逻辑顺序关系

注意事项

  1. 当sortEntryPoints设置为false时,确保entryPoints数组中的顺序确实是你想要的最终顺序
  2. 这个设置只影响顶级模块的排序,不影响模块内部成员的排序
  3. 如果项目结构发生变化,需要手动更新entryPoints的顺序

通过合理利用sortEntryPoints选项,开发者可以完全掌控TypeDoc生成的文档结构,创建出更符合项目需求和团队规范的API文档。

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

热门内容推荐

最新内容推荐

项目优选

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