___              _ _ ____
   /   |  __________(_|_) __ \____  _  ____  __
  / /| | / ___/ ___/ / / / / / __ \| |/_/ / / /
 / ___ |(__  ) /__/ / / /_/ / /_/ />  </ /_/ /
/_/  |_/____/\___/_/_/_____/\____/_/|_|\__, /
                                      /____/

[ Home | What is AsciiDoxy? | Getting started | Reference documentation | Examples | Contributing | Changelog | GitHub ]

Installation

To get started with AsciiDoxy you need to install at least python and AsciiDoctor. The required versions are specified in the reference documentation.

1. Python

To install python see the python website and/or the documentation of your operating system.

Most Linux distributions install python by default. Make sure the installed version matches the requirements.

On macOS python is also already installed, but this may be a version that is too old for AsciiDoxy. You can use HomeBrew to install a newer version of python.

2. AsciiDoctor

AsciiDoctor runs on ruby. First install ruby for your operating system. See the ruby documentation for instructions.

Then use gem to install AsciiDoctor:

gem install asciidoctor

To generate PDF files, you also need the PDF extension for AsciiDoctor:

gem install asciidoctor-pdf

Some Linux distributions support directly installing AsciiDoctor using its package manager. See the documentation for your operating system, or AsciiDoctor.

3. AsciiDoxy

Finally, install AsciiDoxy using pip:

pip3 install --update asciidoxy

Now you are ready to go.

AsciiDoxy