|
This page asciidoc3.org is currently undergoing major changes. |
Please bear with us for a few days. That’s good news for all asciidoc users!
Some links are broken, we’ll fix this asap.
Introduction
AsciiDoc3 is a text document format for writing notes, documentation,
articles, books, ebooks, slideshows, web pages, man pages and blogs.
AsciiDoc3 files can be translated to many formats (see below).
AsciiDoc3 is written in 100% pure Python3 - you need Python 3.10 or higher to execute (Python 3.13 or 3.14 recommended). If you use the also provided standalone executable with an embedded Python, you don’t need Python at all.
AsciiDoc3 is a free software, licensed under the terms of the GNU Affero General Public License version 3 or later (AGPLv3+).
AsciiDoc3 Markup is Better
AsciiDoc3 renders text files, written in asciidoc-makup syntax, to good looking output. At your choice, it converts to
• HTML • PDF • DocBook 4.5/5.1 • EPUB • man page • dvi • ps • tex •
In some cases additional open-source apps are necessary, in overmost use cases not. AsciiDoc3 is highly configurable: both the AsciiDoc3 source file syntax and the backend output markups (which can be almost any type of SGML/XML markup) can be customized and extended by the user.
Usage, Examples, Ressources
You write an AsciiDoc3 document the same way you would write a normal text document, there are no markup tags or weird format notations. AsciiDoc3 files are designed to be viewed, edited and printed directly or translated to other presentation formats using the asciidoc3 (and/or the coherent a2x3) command.
|
The best way to learn more about AsciiDoc3 is to take a look to the cheatsheet! |
In addition there are a lot of templates in the directories ./doc of the distribution. These files help to learn more about the features of AsciiDoc3.
Here are some free online places to read more about the markup language:
Annotations
The pages you are reading were written using AsciiDoc3 and rendered by HUGO. The corresponding AsciiDoc3 sources can be found here: https://gitlab.com/asciidoc3/asciidoc3-website
The source code of page User Guide is included in the distribution files (./doc/userguide.txt).
asciidoc3.org and AsciiDoc3 are work-in-progress. Please return regularly to see the new versions of the asciidoc3-executable and the documentation.
I thank all the contributors for their awesome work.
In consequence of the MicroSoft/GitHub deal in June 2018 AsciiDoc3 leaved GitHub and migrated to GitLab. Here you can find us:
https://gitlab.com/asciidoc3/asciidoc3