Compodoc: [FEATURE] Custom menu items

[rafapaulin]

It would be nice if we could, somehow, tag our comments with something that would be read and used to group items on a specific item menu.

I.E.: I have a few validators, as well as some helper functions on my code, both being simple function. When I generate the docs, both types get bundled in a same page in the docs (mist>functions). It would be interesting to have a way to separate them in a "helpers" and "validators" menu item, each with its own html page

[benelliott]

@vogloblinsky I think the functionality of being able to define your own logical groupings has become a lot more important since Angular introduced tree-shakeable providers. Now that I have stopped listing providers in individual modules of my library, Compodoc has no idea which injectables are related to which modules and so just lists all of them together.

So my menu currently looks like this:

FeatureAModule
  Components
    FeatureAComponent
FeatureBModule
  Components
    FeatureBComponent

CLASSES
FeatureAClass
FeatureBClass

INJECTABLES
FeatureAService
FeatureBService

When I actually want it to look like this:

FEATURE A
  Modules
    FeatureAModule
  Components
    FeatureAComponent
  Classes
    FeatureAClass
  Injectables
    FeatureAService

FEATURE B
  Modules
    FeatureBModule
  Components
    FeatureBComponent
  Classes
    FeatureBClass
  Injectables
    FeatureBService

Is there any workaround for this currently?

[Blakesalot]

@vogloblinsky My team would also use this feature. We'd like to organize our docs in a way that's similar to angular material in which each component is categorized according to how it's used.

[fauverism]

Yeah, I'd love this as well.

[abarreau]

I'd love this feature as well.

[stale[bot]]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

[abarreau]

Any update on this particular feature ?

[stale[bot]]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

[benelliott]

Bump to keep open

[stale[bot]]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

[benelliott]

Bump to keep open

[stale[bot]]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

[stale[bot]]

This issue has been automatically closed because it has not had recent activity. Please file a new issue if you are encountering a similar or related problem. Thank you for your contributions.

[lock[bot]]

This issue has been automatically locked due to inactivity. Please file a new issue if you are encountering a similar or related problem. Why locking ? Having issues with the most up-to-date context.