Handle custom admonition syntax #95
Merged
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
Signed-off-by: Damian Stasik <[email protected]>
damianstasik
force-pushed
the
handle-custom-admonition-syntax
branch
from
ce0a5dc to
b6e5917
Compare
Deploying registry-ui with
|
| Latest commit: |
2ff4d8c
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://2aa306fb.registry-ui-dxi.pages.dev |
| Branch Preview URL: | https://handle-custom-admonition-syn.registry-ui-dxi.pages.dev |
Signed-off-by: Damian Stasik <[email protected]>
Signed-off-by: Damian Stasik <[email protected]>
Signed-off-by: Damian Stasik <[email protected]>
Signed-off-by: Damian Stasik <[email protected]>
Yantrio
approved these changes
Sep 3, 2024
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.
This adds support for the custom admonition syntax that providers and modules may use in their docs to render special blocks with warnings/notes/etc. We could probably convert this into a remark/rehype plugin but this approach was quicker to implement.
We could also add support for the syntax that GH supports so that maintainers of providers and modules could render these blocks on both GH and our Registry UI in a unified way.
Closes #80