Antora is a fairly new open source static site generator, aimed at Technical Authors who prefer writing in AsciiDoc than Markdown. SitePoint describes a static site generator as: A compromise between using a hand-coded static site and a full CMS (such as WordPress or Confluence). You generate an HTML-only website using raw data (such as… Read more »
Category: Software
Two mobile apps of interest
Here’s a couple of mobile apps that might interest you. SoundNote (IoS) SoundNote tracks what you type and draw while recording audio. When you are playing back your recording, if you tap a word, SoundNote will jump straight to that point in the audio. You can share your text, drawings, and audio notes via email,… Read more »
New features in Windows that could be useful for Technical Authors
Microsoft has released a update to Windows 10, and it contains some new features that might be useful for Technical Authors. Cloud clipboard You can: Make a piece of content permanently available on the clipboard, by using the Pin feature. Synchronise your clipboards (and their content) to different devices. This enables you to copy text from one… Read more »
Editing and proofreading content with linters
A linter is a software utility that flags “suspicious usage” in software. Although linters are used by developers mostly to write more bug-free code, there are a few utilities emerging that work with documentation. They could be useful if you’re writing Web pages, markdown files or XML files. Write good checks for passive voice, repeated words, adverbs, weasel words,… Read more »
One to watch – Swagger2markup
Swagger2Markup promises to simplify the generation of REST API documentation by combining auto-generated API documentation produced by Swagger with manually written content. To include the programmatically generated snippets in your documentation, you’d use Asciidoc’s Include macro. The output would look like this: