AsciiDoc3
Text based document generation using Python 3.x

»Home  »User Guide  »Download  »Install  »Quickstart  »PyPI  »AsciiDoc3port  »Release Notes  »Blog  »Donate  »Contact  »Legal Stuff

AsciiDoc3 goes PyPI (2018-10-19)
The team is happy to announce the availability of AsciiDoc3 on PyPI. You can find us here:

Be sure to visit our PyPI Info Page before installing.

Tip In consequence of the MicroSoft/GitHub deal AsciiDoc3 migrated to GitLab. You can find us here:
https://gitlab.com/asciidoc3/asciidoc3
The repo on GitHub is still open for comments, but all further development will be on GitLab.

AsciiDoc3 is 100% pure Python3 - you need Python3.x to execute the program. All of the onehundred and seventy testcases defined in the AsciiDoc (Python2) distribution pass without errors and a binary identical result. See the information given on this page for download and installation instructions.
AsciiDoc3 is licensed under the terms of the GNU General Public License version 2 or later (GPLv2+).

On this page, in all related documents, and all the stuff around I make heavy use of the documents given on asciidoc.org and the software bundle.
The pages you are reading were written using AsciiDoc3, the corresponding AsciiDoc3 sources can be found here: https://gitlab.com/asciidoc3/asciidoc3-website
The source code of page User Guide (userguide.txt) is given in the distribution tarball, so you can test this by yourself, see here.
This site asciidoc3.org undergoes significant updating. Please return regularly to see the new versions of the asciidoc3-executable and the documentation.
I thank all the contributors for their awesome work.

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 including HTML, PDF, EPUB, man page. AsciiDoc3 is written in Python3.x

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.

AsciiDoc3 is a free software (GPLv2+).

Overview and Examples

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 command.

The asciidoc3 command translates AsciiDoc3 files to HTML, XHTML and DocBook markups. DocBook can be post-processed to presentation formats such as HTML, PDF, EPUB, DVI, LaTeX, roff, and Postscript using readily available Open Source tools.

Bug reports

  • When reporting problems please illustrate the problem with the smallest possible example that replicates the issue (and please test your example before posting). This technique will also help to eliminate red herrings prior to posting.

  • Paste the commands that you executed along with any relevant outputs.

  • Include the version of AsciiDoc3 and the platform you’re running it on.

  • If you can program please consider writing a patch to fix the problem.