It's funny how markdown has won in so many tools for prose, but doc comments syntax is so varied.
Rust and Julia are largely markdown, Python is ReST plus doctest syntax, and Java even an HTML dialect!
miniblog.
Related Posts
6
Terminad is a really interesting approach to rendering markdown in the CLI. It deliberately doesn't render links, so you can always see both the link text and the URL.
In a browser you have hover to see URLs, but not necessarily in a terminal.
31
One cute feature of markdown I'd not noticed before: there's no syntax for images *without* a description (i.e. alt text).
22
Today I learnt that you can mix HTML inline in markdown! For example, the following is valid.
Foo <hr/>
I'd assumed that you needed HTML separately, like ``` blocks, but no: https://spec.commonmark.org/0.31.2/#raw-html
Admittedly HTML is very restricted on most sites, but it's helpful for SSGs.