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

Getting started

A step-by-step guide to get you started with AsciiDoxy.

  1. Installation: Install AsciiDoxy and everything required to run it.

  2. A basic AsciiDoc file: Generating HTML out of a basic AsciiDoc file.

  3. Using python in AsciiDoc files: Using python code to generate parts of your documentation.

  4. Multipage documents: Splitting the HTML output into multiple pages with convenient navigation.

  5. Packages: Separating documentation in packages.

  6. Including API reference: Add API reference documentation extracted from source code.

  7. Custom templates: Customize the generated output of AsciiDoxy with your own templates.

  8. Stylesheets: Using stylesheets to customize the HTML output.

AsciiDoxy