User Tools

AsciiDoc: plain text for fancy output

  • Format: Talk (20 min)
  • Difficulty: Beginner - Moderate
  • Track: Technical
  • Additional Tags: AsciiDoc, Documentation, Plaintext, Markup, Technical Writing, Sysadmin
  • Experience: FLOSS community leader and conference speaker; chairperson of the Phoenix Linux User Group (PLUG) and professional manager of database support engineers.

Description:

Plain text, revision control, and wikifiable—this is the “trifecta of sysadmin documentation awesomeness.” AsciiDoc is a human-readable plain text markup tool designed for everything from simple notes to full-length books. Created in 2002 as a format for publishing DocBook XML, it has evolved into a powerful tool that can be converted into a wide variety of output formats, including HTML, DocBook, man pages, ODF, ePub, and PDF.

Because it is plain text, AsciiDoc is ideal for use with revision control systems and is supported by WebUI systems like GitHub wikis. This session will familiarize attendees with basic AsciiDoc syntax, use cases, and the process of exporting to different backend formats. Additionally, the talk will explore the specific advantages and disadvantages of AsciiDoc compared to Markdown, helping users determine which tool is right for their documentation needs.

Project URL: https://AsciiDoc.org/

Target Audience:

  • Sysadmins and technical writers
  • Documentation enthusiasts looking for more power than Markdown
  • Open source contributors managing project manuals