feat: GitHub-style markdown alerts as callouts - #405
Open
Ibochkarev wants to merge 1 commit into
Open
Conversation
Convert > [!NOTE|TIP|IMPORTANT|WARNING|CAUTION] blockquotes into existing .c-callout markup after CommonMark. Addresses DocsApp modxorg#353 and the visual-tag part of modxorg/Docs#40. Rebuilt on major-maintenance per review on modxorg#404.
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
1 participant
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.
What does it do?
Renders GitHub-style alert blockquotes as the existing
.c-calloutUI:[!NOTE]→ info[!TIP]→ success[!IMPORTANT]→ warning[!WARNING]/[!CAUTION]→ alertOptional spaces in the marker (
[! NOTE]) work. Nested markdown inside the alert is preserved (parsed by CommonMark first, then rewritten).Adds unit tests and documents the syntax in the README.
Why is it needed?
Related
major-maintenanceper @Mark-H's review note)Test plan
./vendor/bin/phpunit tests/Unit/AlertCalloutFixerTest.php(5 tests)./vendor/bin/phpcs --standard=phpcs.xml src/Helpers/AlertCalloutFixer.php src/Model/Page.php> [!NOTE]/> [!WARNING]after merge