Markdown on Brandon Pugh's Blog

Alerts, Callouts, and Admonitions

Sun, 31 May 2026 00:00:00 +0000

What my site currently supports:

Note

Highlights information that users should take into account, even when skimming.

Tip

Optional information to help a user be more successful.

Important

Crucial information necessary for users to succeed.

Warning

Critical content demanding immediate user attention due to potential risks.

Caution

Negative potential consequences of an action.

Prior art

Admonish the Callout - Mandaris inspired me to finally implement on my blog
antfu/markdown-it-github-alerts: Support GitHub-style alerts for markdown-it

Thank you for keeping RSS alive. You're awesome.

Reply by email

Collapsible markdown section

Sat, 19 Apr 2025 00:00:00 +0000

Collapsible markdown TIL from williln/til

Click me

Favorite Disney Movies

Wall-E
Moana

Thank you for keeping RSS alive. You're awesome.

Reply by email

Semantic line breaks (one sentence per line)

Tue, 08 Apr 2025 00:00:00 +0000

I just discovered Semantic Line Breaks. I could never decide on exactly how to do line breaks in markdown so I love that someone came up with a convention that’s been thought through.

This led me to discover this post by Derek Sivers: Writing one sentence per line

What’s interesting is that while he’s recommending the same approach, he suggests that it will improve your writing itself.

Nicer git diffs is just a side benefit. 🙂

Definitely going to adopt this now and see how I like it.

Thank you for keeping RSS alive. You're awesome.

Reply by email

You can style markdown links as code

Tue, 18 Mar 2025 00:00:00 +0000

I just figured out that you can style a link as inline code in markdown i.e. toSorted() It’s a bit non-intuitive since, unlike bold or italics, the backticks go inside the square brackets instead of around the entire link.

This gives a bold link: **[EFF](https://eff.org)**.
This is for italics: *[Markdown Guide](https://www.markdownguide.org)*.
And this is for code: [`toSorted()`](https://www.brandonpugh.com/til/javascript/tosorted/).

In my testing this seems supported in most places like github and azure devops. Unfortunately I couldn’t find a way get it styled like that in Teams.

Thank you for keeping RSS alive. You're awesome.

Reply by email