Skip to content
Global sound
Web Dev with Matt

Web Dev with Matt

Don't use Markdown for technical documentation

· 27 min · Season 2 Episode 32

Show notes

If you've written technical documentation, you'll know about Markdown. It's easy to get started with. It's easy to write. It's supported by just about any and every platform and service you're going to use, e.g., GitHub, GitLab, StackOverflow, Reddit, LinkedIn, and numerous other services.
Despite that, it's not the best choice for technical documentation! However, there are two formats: AsciiDoc and reStructuredText, that are. What's more, these formats were designed with technical documentation in mind.
In this episode, I step through my frustrations documenting software with Markdown, and…

Website: share.transistor.fm

Live, last hour: 14,191 songs on 5,937 stations in 117 countries

Discover the world through radio

More ways to discover (9)

Heard something good? Save it, or open it straight away in Spotify.

★ Artist of the week The fastest riser on the radio this week
Your song here? From € 9 per week →
Radio 538 luisteren - Live!Popular right now