33 lines
1.5 KiB
Plaintext
33 lines
1.5 KiB
Plaintext
|
=== About AsciiDoc
|
|||
|
|
|
|||
|
|
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.
|
|||
|
|
|
|||
|
|
The AsciiDoc syntax is intuitive because it builds on well-established,
|
|||
|
|
plain text conventions for marking up and structuring text.
|
|||
|
|
Someone unfamiliar with AsciiDoc can probably guess the purpose of
|
|||
|
|
many of its syntax elements just by looking at them.
|
|||
|
|
That’s because the elements of the syntax were carefully chosen to look
|
|||
|
|
like what they mean (a practice long employed by the tech industry).
|
|||
|
|
|
|||
|
|
The AsciiDoc language isn’t coupled to the output format it produces.
|
|||
|
|
An AsciiDoc processor can parse and comprehend an AsciiDoc source document
|
|||
|
|
and convert the parsed document structure into one or more output formats,
|
|||
|
|
such as HTML, PDF, EPUB3, man(ual) page, or DocBook. The ability to produce
|
|||
|
|
multiple output formats is one of the main advantages of AsciiDoc.
|
|||
|
|
This capability enables it to be used in static site generators,
|
|||
|
|
IDEs, git tools and services, CI/CD systems, and other software.
|
|||
|
|
|
|||
|
|
AsciiDoc bridges the gap between ease of writing and the rigorous
|
|||
|
|
requirements of technical authoring and publishing. AsciiDoc only requires
|
|||
|
|
a text editor to read or write, thereby offering a low bar to getting started.
|
|||
|
|
|
|||
|
|
[[section-b]]
|
|||
|
|
=== Section B
|
|||
|
|
|
|||
|
|
// tag::section-b[]
|
|||
|
|
This is section B from document-b.adoc
|
|||
|
|
// end::section-b[]
|