Repository navigation
Add Alert Callout Reference meta tutorial - #9
Merged
Merged
Conversation
Single-step reference showing every GitHub-style alert the platform renders (NOTE, TIP, IMPORTANT, WARNING, CAUTION) plus plain and bold-lead-in blockquotes, side by side, with the markdown source for each and a when-to-use-which quick reference. Colors match the shipped Hugo render hook + sap-fundamental CSS (IMPORTANT = purple per #2703, not the stale blue in writing-tutorials.md).
Content (1)
Checked de7810f • notify-only, does not block merge |
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
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
A new single-step meta tutorial, Alert Callout Reference, that shows every alert and blockquote style the platform renders — side by side in one step — so authors can see exactly what each looks like and pick the right emphasis.
Covers all five GitHub-style alerts plus the plain and bold-lead-in blockquote forms:
> text(no designator)> [!NOTE]> [!TIP]> [!IMPORTANT]> [!WARNING]> [!CAUTION]Each block shows the markdown source followed by the live rendering, plus a "pick by intent, not loudness" note.
Why
Requested as a companion to the feature cookbook — authors had no single place to eyeball the alert styles.
Notes for reviewers
hugo/layouts/_default/_markup/render-blockquote.html) andsap-fundamental.src.cssintutorials-ims— not the author doc.tutorials-ims/docs/authors/writing-tutorials.md§"Alert callouts" still lists[!IMPORTANT]as blue, but the shipped CSS renders it purple (per #2703). This tutorial matches the CSS. The doc should be corrected separately in thetutorials-imsrepo.tutorial-platform-feature-cookbook.