feat(api-markdown-documenter): Add documentation domain to mdast transformation #24787
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
…n into its own type
github-actions
bot
added
base: main
…com/Josmithr/FluidFramework into api-markdown-documenter/EscapedText
…documenter/documentation-to-mdast
Josmithr
commented
Jun 10, 2025
...n/simple-suite-test/sparse-config/test-suite-a/testclass-testclassgetterproperty-property.md
Show resolved
Hide resolved
|
|
||
| Test package | ||
|
|
||
| # Remarks {#test-suite-a-remarks} | ||
|
|
||
| This remarks block includes a bulleted list! | ||
|
|
||
| - Bullet 1 | ||
| \- Bullet 1 |
There was a problem hiding this comment.
TODO: make sure list items don't get escaped
...arkdown-documenter/src/test/snapshots/markdown/simple-suite-test/flat-config/test-suite-a.md
Outdated
Show resolved
Hide resolved
...shots/markdown/simple-suite-test/sparse-config/test-suite-a/testnamespace-testclass-class.md
Outdated
Show resolved
Hide resolved
| node: HorizontalRuleNode, | ||
| context: TransformationContext, | ||
| ): [MdastThematicBreak] { | ||
| // TODO: Do we need to do anything special in tables? |
There was a problem hiding this comment.
TODO: add a unit test for this
| } | ||
|
|
||
| /** | ||
| * TODO |
...n-documenter/src/documentation-domain-to-markdown/default-transformations/TableToMarkdown.ts
Outdated
Show resolved
Hide resolved
| import type { TransformationContext } from "../TransformationContext.js"; | ||
|
|
||
| /** | ||
| * TODO |
| } | ||
|
|
||
| /** | ||
| * TODO |
...rkdown-documenter/src/documentation-domain-to-markdown/test/CustomNodeTypeToMarkdown.test.ts
Outdated
Show resolved
Hide resolved
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.
Also replace custom Markdown rendering with
mdast-util-to-markdown.