feat: Add (read more) links to md format #319
Open
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.
Hey all,
Here's a little quality of life improvement that I would like to use for the schema documentation in Nix. (wip)
Thank you for considering!
Cheers, Robert
Add read more links to the properties table in the
mdformat when it has both title and description.When a schema property has both a title and description, the table now displays the title with a "(read more)" link to the detailed section. This keeps tables compact and scannable while highlighting the existence of the full documentation.
That would otherwise be easy to miss, especially when embedded in documentation where links in definition lists are merely anchors and readers are used to ignoring those.
Changes:
To be specific the behavior for all four combinations:
Things checked: