C.W.K.
Stream
Lesson 03 of 08 · published

Strikethrough, Autolinks & Inline References

~10 min · markdown, gfm, strikethrough, autolinks

Level 0Plaintext
0 XP0/64 lessons0/12 achievements
0/100 XP to next level100 XP to go0% complete

Three GFM extensions that show up in every PR

Strikethrough

Wrap text in double tildes: ~~deprecated~~. Single tildes do nothing in GFM. Strikethrough is the polite way to mark removed steps in a checklist or deprecated values in a doc — the original is still readable, but the visual cue is unmistakable.

Autolinks for raw URLs

In CommonMark, you have to wrap raw URLs in angle brackets — <https://example.com> — to get a link. GFM auto-detects bare http://, https://, ftp://, and www. URLs in normal prose and turns them into links. No syntax required.

GitHub-only references

On github.com, GFM extends autolinking further: @username mentions a user, @org/team mentions a team, #123 links to issue/PR 123, and a 7+ character SHA links to the commit. These are not portable — they only render outside GitHub if you write the long form yourself.

Email autolink trap: GFM also auto-links bare email addresses (name@example.com). If your README contains a literal email and you don't want it linked, escape with backticks (`name@example.com`) or wrap in HTML (<span>name@example.com</span>).

Code

Strikethrough·markdown
~~deprecated~~ → use the new API
~~50% off~~ → 70% off this week
Autolinks (no syntax needed in GFM)·markdown
Visit https://example.com or www.example.com.
Reach me at me@example.com.

# CommonMark fallback (works everywhere):
Visit <https://example.com>.
Reach me at <me@example.com>.
GitHub references (live on github.com only)·markdown
Thanks @cwk for catching this in #142.
Fix lands in 9c2fc22.
Review from @neobundy/maintainers.

External links

Exercise

Write a tiny changelog entry that uses strikethrough for the old behavior and the new behavior next to it. Then write the same change as a sentence with the issue number in the GitHub #123 form. Render it locally (where #123 is just literal text) and on a test GitHub gist (where it links). Notice when each form is appropriate.

Progress

Progress is local-only — sign in to sync across devices.
Spotted a bug or have feedback on this page?Report an Issue

Comments 0

🔔 Reply notifications (sign in)
Sign inPlease sign in to comment.

No comments yet — be the first.