Refactor Markdown directives for updated syntax compatibility #199
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
Replaced all `{}`-based MyST Markdown directives with `:::` syntax for better editor and parser support. Added new documentation on Markdown extensions and updated test cases accordingly to align with the syntax changes.
The `title_navigation` field was changed from "Markdown Extensions" to "Markdown Syntax" for clarity and consistency. This aligns the navigation label with the document's content and improves user experience.
Corrected a typo in the directive template to ensure it renders properly during tests. This change fixes potential parsing issues caused by the mismatched curly braces.
reakaleek
approved these changes
Jan 14, 2025
tests/Elastic.Markdown.Tests/Directives/AdmonitionUnsupportedTests.cs
Outdated
Show resolved
Hide resolved
…ests.cs Co-authored-by: Jan Calanog <[email protected]>
Replaced inline dictionary with static readonly `FrozenDictionary` and introduced an alternate lookup for better performance. Adjusted tests and trimmed parsing logic to align with the updated implementation.
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.
Replaced all
{}-based MyST Markdown directives with:::syntax for better editor and parser support. Added new documentation on Markdown extensions and updated test cases accordingly to align with the syntax changes.This closes #114 and ensures we follow our own best practices!
This also includes a new documentation page on our usage of markdown and our syntax extensions.