typedoc-plugin-ui-router

TypeDoc plugin: Customized typedoc behavior for UI-Router docs

MIT License

Downloads
248
Stars
1
Committers
2

typedoc-plugin-ui-router

What

A plugin for Typedoc

Customizes some stuff for the UI-Router documentation.

  • Avoids "globals" module in favor of the index page

  • Renames "External Modules" to "Modules" because "external modules" is confusing for a docs page

  • Renames "Globals" nav item to "Subsystems" (configurable through command line argument --navigation-label-globals)

  • Renames "Internals" nav item to "Public API" (configurable through command line argument --navigation-label-internals)

  • Renames "Externals" nav item to "Internal UI-Router API" (configurable through command line argument --navigation-label-externals)

Package Rankings
Top 7.38% on Npmjs.org
Related Projects