Document Module - Render Table Of Contents on server-side #23666
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Replaces client-side TOC generation with a new ITocGeneratorService and TocGeneratorService using HtmlAgilityPack. Updates the project page to render the TOC from the server, removes bootstrap-toc dependencies, and adjusts related JS and CSS for the new TOC structure. Adds HtmlAgilityPack as a dependency.
Introduces a Heading record to replace tuple usage for TOC headings, improving code readability and maintainability. Updates related logic in TocGeneratorService to use the new Heading type and adds constants for heading levels.
Replaces the previous HTML-based table of contents (TOC) extraction using HtmlAgilityPack with a Markdig-based approach. Introduces custom Markdig extensions and renderers to extract headings directly from markdown, updates the TOC service and interface, and removes the HtmlAgilityPack dependency from the project.
Replaces HTML-based TOC generation with a model-based approach by extracting heading data from markdown and rendering the table of contents via a new partial view. Removes the custom Markdig extension and related classes, updates the service interface, and adapts the page model and views to use the new heading list.
Replaces the internal Heading record in TocGeneratorService with a new public TocHeading record class. Updates all references and method signatures to use TocHeading, improving code clarity and reusability.
salihozkara
requested changes
Sep 11, 2025
| <nav id="docs-sticky-index" class="navbar index-scroll"> | ||
| @Html.Raw(Model.TocHtml) | ||
| <nav id="toc" class="navbar index-scroll"> | ||
| <partial name="TableOfContents" model="Model" /> |
There was a problem hiding this comment.
Suggested change
| <partial name="TableOfContents" model="Model" /> | |
| <partial name="TableOfContents" model="Model.TocHeadings" /> |
| @@ -0,0 +1,73 @@ | |||
| @model Volo.Docs.Pages.Documents.Project.IndexModel | |||
There was a problem hiding this comment.
Suggested change
| @model Volo.Docs.Pages.Documents.Project.IndexModel | |
| @model List<Heading> | |
| @@ -0,0 +1,73 @@ | |||
| @model Volo.Docs.Pages.Documents.Project.IndexModel | |||
| @{ | |||
| if (Model.TocHeadings == null ||Model.TocHeadings.Count == 0) | |||
There was a problem hiding this comment.
Suggested change
| if (Model.TocHeadings == null ||Model.TocHeadings.Count == 0) | |
| if (Model == null || Model.Count == 0) | |
| return; | ||
| } | ||
|
|
||
| var relevantHeadings = Model.TocHeadings |
There was a problem hiding this comment.
Suggested change
| var relevantHeadings = Model.TocHeadings | |
| var relevantHeadings = Model | |
|
|
||
| if (relevantHeadings.Count == 0) | ||
| { | ||
| relevantHeadings = Model.TocHeadings |
There was a problem hiding this comment.
Suggested change
| relevantHeadings = Model.TocHeadings | |
| relevantHeadings = Model | |
Updated the TableOfContents partial to accept a List<TocHeading> instead of the full IndexModel, simplifying its interface. Adjusted the Index.cshtml to pass Model.TocHeadings directly. Removed the unused TableOfContents.cshtml.cs code-behind file.
Replaces flat TocHeading list with hierarchical TocItem structure for document table of contents. Updates rendering logic, service interface, and implementation to support nested headings and configurable levels.
Enhanced TocGeneratorService by refactoring heading parsing, optimizing inline text extraction, and improving handling of empty or invalid markdown. Added helper methods for pipeline creation, heading construction, and inline processing for better readability and maintainability.
salihozkara
approved these changes
Sep 18, 2025
Replaces the use of a fixed max TOC level with a level count parameter in TOC generation methods and logic. This change improves flexibility by allowing the number of heading levels included in the TOC to be specified, rather than a maximum heading level value.
yagmurcelk
approved these changes
Sep 22, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Resolves #23643
Checklist
How to test it?
This PR should be tested in conjunction with the corresponding vs-internal PR.