Markdown

Migrating documentation

Migrating documentation from one software platform to another can be painful. I remember the days when moving a Word document back and forth between Mac and Windows caused problems. I started working …

Bulk converting Markdown to HTML

Converting Markdown to HTML is easy. Just publish it with a static site generator (SSG). But maybe you’re using a cloud-based Markdown documentation solution, and you don’t have a local …

Component single-source multi-channel publishing with Markdown

This week, I finished work on the final beta of the classic BASIC interpreter I’ve been working on for the Chloe 280SE FPGA retro computer project. Like many home computers from the 1970s to the …

Low budget developer portal

Back in 2019, I had to create a developer portal with no budget. I wrote up the experience and last year I published it here as a three part series. My requirements were that it would have the …

Managing a ReadMe.io site from a Git repository

ReadMe.io is a popular user docs site. It has a Markdown editor, theme builder and Swagger / OpenAPI file import. It’s fast and responsive, and it looks nice. But the last time I checked, all …

Creating diagrams with Mermaid

I’m a convert to writing docs in Markdown. Most of this website is written using it (displayed with Hugo). But sometimes you need to include a chart or diagram in your docs. Historically, this …