Markdown links have brackets backwards

Software

Markdown has so many frustrating limitations, undefined behaviours, and incompatible implementations, but its utility just outweighs it all to still be useful in certain circumstances.

The order of link elements have always seemed backwards to me. This is a Markown link:

[link text](target "description")

And here’s the equivilent HTML anchor:

<a title="description" href="target">link text</a>

Markdown is supposed to be human readable, so I agree that it makes it more sense to read the text for a link before its URL. We could debate all day about how XML/SGML got the order wrong where it should have put the URL and other attributes in the closing element, not the opening.

But to me, Markdown square brackets look mechanical and robotic, and rounded brackets look natural and human. So the machine code—aka, the URL—should be in the square brackets, and the human part should be in the rounded ones:

(link text)[target "description"]

I still instinctively reach for round brackets to start links like this, despite having written Markdown for more than a decade. It just makes more visual sense. Maybe I could start my own flavour called Common(Sense)MarkII.

While I’m here, I’ve since learned that American English refers to rounded brackets as parentheses. For a language seemingly hell-bent on dropping letters from colourful, flavourful words, it seems strange that an entirely new and superflous one would be invented and used. I guess that’s the great thing about English, nowhere does it make sense.

Author bio and support

Me!

Ruben Schade is a technical writer and IaaS engineer in Sydney, Australia who refers to himself in the third person in bios. Wait, not BIOS… my brain should be EFI by now.

The site is powered by Hugo, FreeBSD, and OpenZFS on OrionVM, everyone’s favourite cloud infrastructure provider.

You can leave me a comment by contacting me, and I might publish your thoughts. Please read the FAQs first though.

If you found this post helpful or entertaining, you can shout me a coffee or buy some silly merch. Thanks!