Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add an option to generate a table of contents for large API references #584

Open
Chriscbr opened this issue Feb 1, 2022 · 0 comments
Open
Labels
feature-request A feature should be added or improved. p2

Comments

@Chriscbr
Copy link
Contributor

Chriscbr commented Feb 1, 2022

This was available in jsii-docgen v1 but I think the enhancement was removed in v2. On https://constructs.dev/ we provide a table of contents automatically, but adding a table of contents within the generated markdown would make it easier to see all of the classes, structs, enums etc. that are available at a glance when rendering the docs on GitHub, GitLab, etc.

Example: https://github.com/projen/projen/blob/v0.46.0/API.md

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature-request A feature should be added or improved. p2
Projects
None yet
Development

No branches or pull requests

1 participant