Add HeadingSummary plugin for extracting article headings as navigation metadata#8
Draft
Add HeadingSummary plugin for extracting article headings as navigation metadata#8
Conversation
Co-authored-by: AlexHedley <1573469+AlexHedley@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Extract blog article headings for navigation
Add HeadingSummary plugin for extracting article headings as navigation metadata
Mar 14, 2026
Owner
|
@copilot update the site project in the sample folder to use the plugin and confirm the it is working |
Agent-Logs-Url: https://github.com/AlexHedley/statiq.plugins/sessions/6a5c921c-3a5e-4d11-b94e-03326786ba31 Co-authored-by: AlexHedley <1573469+AlexHedley@users.noreply.github.com>
Author
Done in c7c0c49. Updated return await Bootstrapper
.Factory
.CreateWeb(args)
.AddConfigurator<Bootstrapper, ReadingTimeConfigurator>()
.AddConfigurator<Bootstrapper, HeadingSummaryConfigurator>()
.RunAsync();The site generates successfully ( |
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
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.
Implements a new
HeadingSummaryplugin that parses post HTML and stores a structured list of headings as document metadata, enabling in-page navigation (table of contents, sidebars, etc.).New plugin:
HeadingSummaryHeading.cs— Data model withLevel(int),Id(string?),Text(string?)HeadingSummaryModule.cs—ParallelModuleusing HtmlAgilityPack to selecth1–h6nodes and emit aList<Heading>under the"Headings"metadata keyHeadingSummaryConfigurator.cs—IConfigurator<Bootstrapper>that inserts the module into theContentpipeline at position 3, matching theReadingTimepatternSample updates
1.md— headings promoted to proper markdown with{#anchor-id}syntax_sidebar.cshtml— rendersHeadingsas a navigation<ul>with anchor linksProgram.cs— explicitly registers bothReadingTimeConfiguratorandHeadingSummaryConfiguratorviaAddConfigurator<Bootstrapper, T>()Usage
Add headings with IDs in your markdown:
## My Section {#my-section}Register the configurator in your
Program.cs:Render in a template:
@{ var headings = Model.GetList<Statiq.Plugins.Heading>("Headings"); } @foreach (var heading in headings) { <li class="heading-level-@heading.Level"> <a href="#@heading.Id">@heading.Text</a> </li> }Original prompt
📱 Kick off Copilot coding agent tasks wherever you are with GitHub Mobile, available on iOS and Android.