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

[Feature Request] Create Class, Interface and Enums as expanders in the TOC for .NET Documentation #9934

Closed
UmaHarano opened this issue May 21, 2024 · 4 comments · Fixed by #9965
Labels
dotnet Generate .NET API reference docs

Comments

@UmaHarano
Copy link

The TOC for my .NET assembly namespace types lists "Classes" "Interface" and "Enums" as "Toc Titles". Is there a way to make them into expanders in the TOC instead? This will make the TOC more compact. I have many types in a namespace and it would nice to collapse them.

image

I want this behavior instead:
image

Additional information:
#9933 (comment)

@filzrev
Copy link
Contributor

filzrev commented May 21, 2024

The proposed implementation is as follows.

If there seems to be no particular problems. I'll create PR later.

Config document to be added


categoryLayout

Specifies how categories in TOC are organized:

  • flattened (default): Renders namespaces as a plain label.
  • nested: Renders category in a nested tree form.

Note

This setting is is available when using ApiPage or Markdown output format. mref format don't support categories.

@yufeih yufeih added the dotnet Generate .NET API reference docs label May 21, 2024
@yufeih
Copy link
Contributor

yufeih commented May 21, 2024

We could incorporate this change if there is sufficient interest. Please upvote if you find this useful.

@UmaHarano
Copy link
Author

What is the best way to Upvote? In this issue or in the original discussion thread?

@UmaHarano
Copy link
Author

UmaHarano commented May 21, 2024

Also, I want to also add that -
when I use outputFormat = apiPage, my custom template is not being used. I lose the ability to customize the site with my template (partial files, main.js, etc).
If there is a workaround for this, please let me know.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dotnet Generate .NET API reference docs
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants