AsciiDoc is a text document format for writing notes, documentation, articles, books, slideshows, man pages & blogs. AsciiDoc can be translated to many formats including HTML, DocBook, PDF, EPUB, and man pages. NOTE: This implementation is written in Python 2, which EOLs in Jan 2020. AsciiDoc development is being continued under @asciidoctor.
Python JavaScript CSS XSLT Shell Vim script Other
Clone or download
Latest commit 6896335 Mar 29, 2018
Permalink
Failed to load latest commit information.
dblatex Adding the package 'upquote' in style file to preserve correct quotes… Sep 17, 2014
doc Update a2x.1.txt Mar 29, 2018
docbook-xsl Added ruler and line-break outputs to HTML Help outputs. Patch submit… Aug 25, 2012
examples/website Prepare 8.6.10 release Sep 22, 2017
filters Update shebang to python2 May 14, 2017
images Website updates. Jan 25, 2011
javascripts FIXED: Duplicated entries in TOC of large document. Patch submitted by Dec 18, 2011
stylesheets Wrap pre blocks at right margin (see Feb 16, 2013
tests Adding the ability to change "Last Updated" field Mar 8, 2016
themes add support for line decorations in text to the volnitsky theme Nov 18, 2014
vim/syntax Vim sytnax file: Changed "highlight link" to more usual "hi def link"… Mar 15, 2013
.gitignore Add created .png to .gitignore May 15, 2014
.travis.yml Fix build by removing reference to obsolete and no longer unneeded PP… Feb 5, 2018
BUGS.txt Bump required Python version to 2.6 instead of 2.4 Jun 29, 2014
CHANGELOG.txt Prepare 8.6.10 release Sep 22, 2017
COPYING For consistency converted all DOS formatted configuration and text fi… Apr 15, 2011
COPYRIGHT For consistency converted all DOS formatted configuration and text fi… Apr 15, 2011
INSTALL.txt Merge pull request #37 from florentx/require26 Sep 29, 2017
MANIFEST Update build files to as latex2png was renamed to latex2img Mar 16, 2015
Makefile.in Specify python 2 explicitly in makefile Dec 12, 2017
README.asciidoc Bump required Python version to 2.6 instead of 2.4 Jun 29, 2014
a2x.py Prepare 8.6.10 release Sep 22, 2017
asciidoc.conf Added {plus} intrinsic attribute. See Dec 31, 2012
asciidoc.py Merge pull request #115 from bmwiedemann/release Sep 29, 2017
asciidocapi.py Remove duplicate run of doctest.testmod May 15, 2014
common.aap Prepare 8.6.10 release Sep 22, 2017
configure.ac Prepare 8.6.10 release Sep 22, 2017
docbook45.conf Fix xref macro docbook output Jun 28, 2015
help.conf Changed AsciiDoc domain to asciidoc.org. Dec 28, 2012
html4.conf Adding the ability to change "Last Updated" field Mar 8, 2016
html5.conf Adding the ability to change "Last Updated" field Mar 8, 2016
install-sh Reinstated install-sh (version automake-1.11), see: Dec 31, 2012
lang-cs.conf Adding the ability to change "Last Updated" field Mar 8, 2016
lang-de.conf Adding the ability to change "Last Updated" field Mar 8, 2016
lang-el.conf Adding the ability to change "Last Updated" field Mar 8, 2016
lang-en.conf Adding the ability to change "Last Updated" field Mar 8, 2016
lang-es.conf Adding the ability to change "Last Updated" field Mar 8, 2016
lang-fi.conf Add Finnish language configuration Sep 17, 2016
lang-fr.conf Adding the ability to change "Last Updated" field Mar 8, 2016
lang-hu.conf Adding the ability to change "Last Updated" field Mar 8, 2016
lang-id.conf Indonesian translation Mar 6, 2017
lang-it.conf Merge pull request #9 from aerostitch/update_bottom_text Aug 17, 2016
lang-ja.conf Adding the ability to change "Last Updated" field Mar 8, 2016
lang-nl.conf Adding the ability to change "Last Updated" field Mar 8, 2016
lang-pl.conf Add template to Last Updated Sep 25, 2016
lang-pt-BR.conf Adding the ability to change "Last Updated" field Mar 8, 2016
lang-ro.conf Adding the ability to change "Last Updated" field Mar 8, 2016
lang-ru.conf Adding the ability to change "Last Updated" field Mar 8, 2016
lang-sv.conf Adding the ability to change "Last Updated" field Mar 8, 2016
lang-uk.conf Ukrainian: Translate 'Version' and 'Last update' Sep 24, 2016
latex.conf latex.conf: Fixed bad escapes. Patch submitted by Mark McCurry: Aug 8, 2011
main.aap - Bumped version number. Feb 16, 2011
slidy.conf Replaced obsolete <tt> tag with <code> in HTML backends. Jun 17, 2012
text.conf For consistency converted all DOS formatted configuration and text fi… Apr 15, 2011
xhtml11-quirks.conf - FIXED: All Python filters are executed with the same Python Feb 29, 2012
xhtml11.conf Adding the ability to change "Last Updated" field Mar 8, 2016

README.asciidoc

AsciiDoc Build Status

AsciiDoc is a text document format for writing notes, documentation, articles, books, ebooks, slideshows, web pages, man pages and blogs. AsciiDoc files can be translated to many formats including HTML, PDF, EPUB, man page.

AsciiDoc is highly configurable: both the AsciiDoc 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.

Prerequisites

AsciiDoc is written in Python so you need a Python interpreter (version 2.6 or 2.7) to execute asciidoc(1). Python is installed by default in most Linux distributions. You can download Python from the official Python website http://www.python.org.

Obtaining AsciiDoc

Documentation and installation instructions are on the AsciiDoc website http://asciidoc.org/

Tools

Current AsciiDoc version tested on Xubuntu Linux 10.04 with:

  • Python 2.6.5

  • DocBook XSL Stylesheets 1.76.1

  • xsltproc (libxml 20706, libxslt 10126 and libexslt 815).

  • w3m 0.5.2

  • dblatex 0.3

  • FOP 0.95

  • A-A-P 1.091

Copying

Copyright © 2002-2013 Stuart Rackham. Free use of this software is granted under the terms of the GNU General Public License version 2 (GPLv2).