The Blog

Don't Write Code When You Don't Have To

Don't Write Code When You Don't Have To

August 16th, 2019

Writing code is a very creative endeavour. However, if you're not careful, you may well end up wasting a lot of time writing code that you don't have to.

Avoid Duplicate Content With Antora Page and Site Attributes

Avoid Duplicate Content With Antora Page and Site Attributes

May 30th, 2019

Writing technical documentation has a lot of similarities to writing software; an important one being content reuse, instead of content duplication. In this post, you’ll learn why and how to use attributes in AsciiDoc and Antora to reuse content as and when needed.

How to Create Redirects in Antora

How to Create Redirects in Antora

May 30th, 2019

Whenever you create online documentation, eventually, the structure needs to change; such as a name change, content restructure, or old content is removed. When these times come, it's important to create redirects to avoid breaking user expectations. In this post, I'm going to step you through how to do so with Antora.

4 Git Command-Line Tips for Greater Productivity

4 Git Command-Line Tips for Greater Productivity

May 23rd, 2019

Git, despite still being a bit terse, is extremely powerful version control software. However, because it's so powerful, it takes time to learn. In this post, I'm going to show you four small techniques to help you use it more effectively.

Convert Markdown to AsciiDoc The Right Way! Use kramdoc

Convert Markdown to AsciiDoc The Right Way! Use kramdoc

May 16th, 2019

If you need to migrate Markdown content to AsciiDoc, there's a tool designed specifically to do it — it's called kramdoc. In this post, I'm going to show you how to use it and relate my experience with it.

How to Convert Markdown to AsciiDoc Using Pandoc

How to Convert Markdown to AsciiDoc Using Pandoc

May 9th, 2019

Markdown is one of the most ubiquitous file formats around at the moment for writing technical documentation — and it's easy to see why! However, it may not be the choice long-term. When it's time to change, you need to be able to migrate to a more feature-rich format. Come learn about the best tool for the job and how to use it.

Find What's Using a Port With Two Commands

Find What's Using a Port With Two Commands

March 5th, 2019

If you've ever attempted to bind a process on a port on Linux, BSD, or macOS, only to find that something else is using the port, yet you don't know what that process is, here's a quick way to find the process and remove it.

Easily Find Broken Links With Broken Link Checker

Easily Find Broken Links With Broken Link Checker

January 29th, 2019

When you're reviewing generated HTML content, broken link's are the last thing you want. However, given the massive amount of documentation in modern projects, manually hunting for broken links isn't practical. So how do you deal with this problem?

Validate Your Markdown files with MarkdownLint

Validate Your Markdown files with MarkdownLint

December 21st, 2018

Markdown is far-and-away the most popular technical documentation format used by developers (in my experience). If you and your team write in Markdown too, how do you know that your Markdown files are valid? You use MarkdownLint. Come learn all about it!