Skip to content

Use GitHub Flavored Markdown alerts for some notes#51

Merged
rarkins merged 1 commit intorenovatebot:mainfrom
HonkingGoose:patch-1
May 11, 2024
Merged

Use GitHub Flavored Markdown alerts for some notes#51
rarkins merged 1 commit intorenovatebot:mainfrom
HonkingGoose:patch-1

Conversation

@HonkingGoose
Copy link
Copy Markdown
Contributor

Changes:

  • Use GitHub Flavored Markdown alerts for some notes

Context:

We can make the Note parts "pop" a bit more, by using the GitHub Flavored Markdown alert syntax.

The GitHub Docs, Basic writing and formatting syntax, alerts also shows the alert types:

  • Note
  • Tip
  • Important
  • Warning
  • Caution

I'm doing a one to one replacement for now. The GitHub docs warn us that:

Use alerts only when they are crucial for user success and limit them to one or two per article to prevent overloading the reader. Additionally, you should avoid placing alerts consecutively. Alerts cannot be nested within other elements.

So I'm keeping the nested notes in the old style, as nesting is forbidden. 😄

@rarkins rarkins merged commit 755485b into renovatebot:main May 11, 2024
@HonkingGoose HonkingGoose deleted the patch-1 branch May 11, 2024 13:11
Hoshimikan6490 added a commit to Hoshimikan6490/renovate_tutorial that referenced this pull request Jun 3, 2024
Use GitHub Flavored Markdown alerts for some notes (renovatebot#51)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants