$ hg --version
»Home
»FAQ
»a2x
»API
|
AsciiDoc InstallationTable of Contents
PrerequisitesSee the README page. Installing from the Mercurial repositoryThe AsciiDoc Mercurial repository is hosted by ShareSource. ShareSource is a Mercurial friendly website for hosting Open Source projects. To browse the repository go to http://hg.sharesource.org/asciidoc/. Installing from the repository is an easy way to install AsciiDoc if you don’t have an up to date packaged version or want to get the latest version from the trunk:
You now have two choices, you can run asciidoc directly from you local repository or you can use autoconf(1) and make(1) to perform a normal install from the repository. Running asciidoc from your local repositoryCreate a symlink to the AsciiDoc script in a search PATH directory so it’s easy to execute asciidoc from the command-line, for example: $ ln -s ~/bin/asciidoc-8.5.0/asciidoc.py ~/bin/asciidoc $ ln -s ~/bin/asciidoc-8.5.0/a2x.py ~/bin/a2x Use the Mercurial pull command to update your local AsciiDoc repository. Installing asciidoc for all usersCreate configure using autoconf(1); use configure to create the Makefile; run make(1); build the man pages; install: $ autoconf $ ./configure $ make $ python a2x.py -f manpage doc/asciidoc.1.txt $ python a2x.py -f manpage doc/a2x.1.txt $ sudo make install To uninstall: $ sudo make uninstall Distribution tarball installationThe distribution source tarballs can be downloaded from the SourceForge http://sourceforge.net/projects/asciidoc/. If your flavor or UNIX or Linux does not have a packaged AsciiDoc distribution or if you prefer to install the latest AsciiDoc version from source use the configure shell script in the tarball root directory. The autoconf(1) generated configure script creates a make file that is tailored for your system. To install: $ tar -xzf asciidoc-8.5.0.tar.gz $ cd asciidoc-8.5.0 $ ./configure $ sudo make install To install the documentation: $ sudo make docs To uninstall AsciiDoc: $ sudo make uninstall If Vim is installed on your system the AsciiDoc Vim syntax highlighter and filetype detection scripts will be install in the global Vim configuration file directory (asciidoc.vim in the syntax directory and asciidoc_filetype.vim in the ftdetect directory). Prepackaged AsciiDoc installationThe following platform specific AsciiDoc packages are available:
See also Packager Notes in the AsciiDoc User Guide. Microsoft Windows installationAsciiDoc is developed and tested on Linux but there seem to be quite a few people using it on Windows. To install AsciiDoc on Windows unzip the distribution Zip file contents to a new folder: $ mkdir asciidoc $ cd asciidoc $ unzip ../asciidoc-8.5.0.zip Testing your installationTest out asciidoc by changing to the AsciiDoc application directory and convert the User Guide document (./doc/asciidoc.txt) to XHTML (./doc/asciidoc.html): $ python asciidoc.py doc/asciidoc.txt testasciidoc offers a more extensive set of conformance tests, though you do need to create the test data before running the tests (this in itself is a good post-install test): $ python ./tests/testasciidoc.py update |