fix: ignore mdx-like text in federated docs #33
Conversation
This file contains 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
Docs build is breaking because of MDX-like text in federated docs, which shouldn't have any MDX in the first place (they use mkdocs-compatible Markdown). Alter the syntax tree to ignore these tags and display them as plain text, e.g., `Nullable<T>` should be displayed literally. Also fixes the redundant header removal to make it more robust (syntax-tree based instead of regex-based.)
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.
Docs build is breaking because of MDX-like text in federated docs, which shouldn't have any MDX in the first place (they use mkdocs-compatible Markdown). Alter the syntax tree to ignore these tags and display them as plain text, e.g.,
Nullable<T>should be displayed literally.Also fixes the redundant header removal to make it more robust (syntax-tree based instead of regex-based.)