Technical Writing Articles

How to Set Custom Attributes in the Asciidoctor.js Live Preview Extension

How to Set Custom Attributes in the Asciidoctor.js Live Preview Extension

April 21, 2020

In this post, I step through how to set custom AsciiDoc attributes in the Asciidoctor.js Live Preview Extension for Firefox (and Chromium/Chrome). By doing so, you can preview your content properly and avoid setting attributes directly in your AsciiDoc content and other hacks.

How to Include Remote Sources in AsciiDoc

How to Include Remote Sources in AsciiDoc

April 9, 2020

AsciiDoc can include code from remote sources, not just local files. In this post, I’m going to show you both how to do it, as well as how doing so can make your content extremely flexible and much less intensive to maintain.

Antora 101: How to Create Redirects

Antora 101: How to Create Redirects

April 30, 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.

Convert Markdown to AsciiDoc The Right Way! Use Kramdoc

Convert Markdown to AsciiDoc The Right Way! Use Kramdoc

April 16, 2019

If you need to convert Markdown content to AsciiDoc, there’s a tool specifically designed for the job — 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

April 9, 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.

Easily Find Broken Links With Broken Link Checker

Easily Find Broken Links With Broken Link Checker

April 29, 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 Markdown Files With MarkdownLint

Validate Markdown Files With MarkdownLint

April 21, 2018

How do you know that your Markdown content is valid? You use MarkdownLint! In this post, I step through how to install, configure, and use it, as well as how to use one-time rule overrides.

Antora 101: The Three Core Concepts You Need To Know To Use It Fully

Antora 101: The Three Core Concepts You Need To Know To Use It Fully

April 13, 2018

Antora is the premier technical documentation platform. However, that doesn’t mean that it’s a breeze to use right from the get-go. If you have just begun using it or want to get the most out of it, this post will step you through the three key concepts that you need to know about.

Automate Repetitive Tasks With Make

Automate Repetitive Tasks With Make

April 18, 2018

Anything to do with software and computers usually ends up getting tricky, time-consuming, and repetitive. As such, if you value your sanity, you’ll want to regularly look for ways to automate these tasks away. One of the best ways to do that, is by using Make - a veteran automation tool.

Why Antora Is The Leading Technical Writing Platform

Why Antora Is The Leading Technical Writing Platform

April 12, 2018

If you need to create and maintain technical writing, there are a large number of solutions that will give you a lot of what you want. However, which one is the best? Today, I’ll show you which one I believe is the best choice.

PHP Day 2017 (Dresden)

PHP Day 2017 (Dresden)

April 24, 2017

As I traveled home from PHP Day 2017 in Dresden, I decided to put my thoughts together about the conference, and share them with you, if you weren’t there to enjoy the day yourself.

An Initial Sphinx-Doc Workflow

An Initial Sphinx-Doc Workflow

April 7, 2017

Do you use Sphinx-Doc and reStructuredText to manage your project’s technical documentation? Do you find that it’s a lot of work to ensure content validates and renders correctly? If so, this post walks through an initial workflow which seeks to make the process easier and more efficient.