🚀 Feature: Add a first-class AST node for Markdown headings - #466
Closed
- nyankoiscat - (Hikkywannafly) wants to merge 1 commit into
Closed
🚀 Feature: Add a first-class AST node for Markdown headings#466- nyankoiscat - (Hikkywannafly) wants to merge 1 commit into
- nyankoiscat - (Hikkywannafly) wants to merge 1 commit into
Conversation
Introduce a new `DocHeading` node type so Markdown headings are represented explicitly in the parsed TSDoc tree (instead of being folded into paragraph text). This matches the maintainer guidance in the issue: headings should be regular section members, not a nested section hierarchy. Affected files: DocHeading.ts Signed-off-by: - nyankoiscat - <76279331+Hikkywannafly@users.noreply.github.com>
Contributor
|
- nyankoiscat - (@Hikkywannafly) please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.
Contributor License AgreementContribution License AgreementThis Contribution License Agreement (“Agreement”) is agreed to by the party signing below (“You”),
|
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.
Problem
Introduce a new
DocHeadingnode type so Markdown headings are represented explicitly in the parsed TSDoc tree (instead of being folded into paragraph text). This matches the maintainer guidance in the issue: headings should be regular section members, not a nested section hierarchy.Severity:
highFile:
tsdoc/src/nodes/DocHeading.tsSolution
Define
DocHeadingas a container-like node (parallel toDocParagraph) with:Changes
tsdoc/src/nodes/DocHeading.ts(new)Testing
Closes #197