Enable and use GitHub Alert syntax for admonitions #275
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
github-actions
bot
added
part:docs
|
Before:
After:
|
This allows us to use [GitHub Alerts] in our markdown files, so admonitions can render nicely on GitHub too. [GitHub Alerts]: https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#alerts Signed-off-by: Leandro Lucarella <luca-frequenz@llucax.com>
This allows admonitions/callouts/alerts to be rendered properly both in GitHub and `mkdocs`. On the downside, GitHub syntax is less flexible than `mkdocs`, so we can't have the admonitions be rendered *inline end* any more. Because of this we only use the GitHub syntax for the README, as it is more important that the README is rendered correctly in GitHub than having it look a bit nicer in `mkdocs`. Signed-off-by: Leandro Lucarella <luca-frequenz@llucax.com>
Marenz
approved these changes
Mar 4, 2024
|
I wonder what requirement is missing. |
|
I guess it got borked when I switched the merge queue from a "branch protection" to a "ruleset" #GitHub 🦄 |
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 allows admonitions/callouts/alerts to be rendered properly both in GitHub and
mkdocs. On the downside, GitHub syntax is less flexible thanmkdocs, so we can't have the admonitions be rendered inline end any more.Because of this we only use the GitHub syntax for the README, as it is more important that the README is rendered correctly in GitHub than having it look a bit nicer in
mkdocs.