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 give a healthy plug for why you should use AsciiDoc instead. It's loads better and far more enjoyable to document your code with.
Links from the episode
Want to grow your knowledge further?
Check out the books below, where you can grow your web development skills in a very focused, very hands-on way.
★ Support this podcast on Patreon ★
What is Web Dev with Matt?
Want to learn web development from the comfort of your chair, car, when you're out for a run, or doing some random house work? This is the show for you. Every week, in 20 - 40 minutes, I help you improve your web development skills with new knowledge, tips, pointers, random facts, inspiration, and some general chit chat. Tune in to have a fun, engaging, and friendly conversation about web development.