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

在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文档。