diff --git a/README.md b/README.md index c15910f..be417c5 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ pairing with smart people at Hashrocket. For a steady stream of TILs, [sign up for my newsletter](https://crafty-builder-6996.ck.page/e169c61186). -_1497 TILs and counting..._ +_1498 TILs and counting..._ --- @@ -441,6 +441,7 @@ _1497 TILs and counting..._ ### Internet - [Add Emoji To GitHub Repository Description](internet/add-emoji-to-github-repository-description.md) +- [Add Styled Alerts To GitHub Markdown Documents](internet/add-styled-alerts-to-github-markdown-documents.md) - [Analyze Your Website Performance](internet/analyze-your-website-performance.md) - [Check Your Public IP Address](internet/check-your-public-ip-address.md) - [Digraph Unicode Characters Have A Titlecase](internet/digraph-unicode-characters-have-a-titlecase.md) diff --git a/internet/add-styled-alerts-to-github-markdown-documents.md b/internet/add-styled-alerts-to-github-markdown-documents.md new file mode 100644 index 0000000..d18b3d8 --- /dev/null +++ b/internet/add-styled-alerts-to-github-markdown-documents.md @@ -0,0 +1,40 @@ +# Add Styled Alerts To GitHub Markdown Documents + +The GFM (GitHub Flavored Markdown) variant of markdown adds some nice features +to our GitHub-rendered markdown documents. + +One such feature that has been around for a couple years, but which I only just +learned about, are these styled alerts. There are five of them each with a +different color and icon to help convey meaning. + +``` +> [!NOTE] +> Useful information that users should know, even when skimming content. + +> [!TIP] +> Helpful advice for doing things better or more easily. + +> [!IMPORTANT] +> Key information users need to know to achieve their goal. + +> [!WARNING] +> Urgent info that needs immediate user attention to avoid problems. + +> [!CAUTION] +> Advises about risks or negative outcomes of certain actions. +``` + +I just added the following to the top of one of my project's READMEs to help me +remember that it is not under active development. + +``` +> [!WARNING] +> This repo is not under active development, you might be looking for +> [til-visualmode-dev](https://github.com/jbranchaud/til-visualmode-dev). +``` + +Visit the GitHub docs for +[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) +to see examples of how these render. + +[source](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#alerts)