AsciiDoc Test Bench

AsciiDoc is a lightweight and semantic markup language primarily designed for writing technical documentation. The language can be used to produce a variety of presentation-rich output formats, all from content encoded in a concise, human-readable, plain text format.

About this document

Evaluating AsciiDoc for use in the documentation instead of Markdown.

Some definitions, first:

AsciiDoc	Asciidoctor
AsciiDoc is a lightweight and semantic markup language primarily designed for writing technical documentation. The language can be used to produce a variety of presentation-rich output formats, all from content encoded in a concise, human-readable, plain text format.	Asciidoctor is a fast text processor and publishing toolchain for converting AsciiDoc content to HTML5, DocBook, PDF, and other formats. It is written in Ruby and runs on all major operating systems.
https://asciidoc.org/	https://asciidoctor.org/

This document is for:

• To test the AsciiDoc syntax

• To test the AsciiDoc rendering in GitHub

• Try to get a GitHub Action to render the AsciiDoc to HTML and publish it to GitHub Pages

  • GitHub Pages

    • https://docs.github.com/en/pages

  • Asciidoctor GitHub Pages Action

Note	This document is not intended to be a comprehensive guide to AsciiDoc. For that, see the links below.

Source code, with syntax highlighting and callouts:

const foo = (bar: string): string => {  (1)
  return bar; (2)
};

1. The function takes a string as a parameter and returns a string.

2. The function returns the string that was passed in.

This is a sidebar.

Documentation

• AsciiDoc Writer’s Guide

  • A Gentle Introduction to AsciiDoc

• AsciiDoc Language Documentation

• Asciidoctor Documentation Site

Tools

• AsciiDoc Tools

• Asciidoctor

  • A fast text processor & publishing toolchain for converting AsciiDoc to HTML5, DocBook & more.

Extensions

• Asciidoctor Diagram

  • A set of Asciidoctor extensions that enable you to include diagrams in your AsciiDoc documents using a number of different formats, including PlantUML, Graphviz, Ditaa, and more.

Other

• Asciidoctor & Structurizr (C4):

  • Architecture docs as code with Structurizr & Asciidoctor. Part 1: Workflow and tooling