Conversation
Signed-off-by: Akash Reddy Jammula <akashreddyjammula@gmail.com>
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.
What is the motivation?
Some pages in the Score example hub display several large example files consecutively. This makes the pages long and difficult to scan when readers only need to inspect one particular file.
This change builds on the original approach proposed by @victor-ikeme in #206 and incorporates the maintainer feedback left on that pull request. As the original pull request has not been updated for some time, this follow-up brings the work onto the current
mainbranch and carries it through to completion.The implementation has been updated for the current generated content and moved into the example-page generator so that future content regeneration preserves the behavior.
Is this related to any issues?
Fixes #201.
Supersedes #206, originally opened by victor. This pull request retains the original idea, applies the requested review changes, updates it for the current content, and implements the behavior in the content generator so it remains consistent after regeneration.
What does this change do?
detailsshortcode using native HTML<details>and<summary>elements, with no JavaScript dependency.score/specification/filesexample inline becausefileA.txtandscore.yamlare easier to understand together.This is an adaptation rather than a direct copy of #206. The shortcode concept and filename-based summaries come from the original contribution, while the generator integration, current generated output, conditional multi-file behavior, specification-page exception, and revised styling are new.
What is your testing strategy?
dprintagainst all changed files.score/specification/filescontains no collapsible sections and continues to displayfileA.txtandscore.yamlinline....placeholders or new border/background styling are present.Local verification: ran hugo.exe server
Primary pages checked:
Have you read the Contributing Guidelines?