___ _ _ ____ / | __________(_|_) __ \____ _ ____ __ / /| | / ___/ ___/ / / / / / __ \| |/_/ / / / / ___ |(__ ) /__/ / / /_/ / /_/ /> </ /_/ / /_/ |_/____/\___/_/_/_____/\____/_/|_|\__, / /____/
[ Home | What is AsciiDoxy? | Getting started | Reference documentation | Examples | Contributing | Changelog | GitHub ]
Getting started
A step-by-step guide to get you started with AsciiDoxy.
-
Installation: Install AsciiDoxy and everything required to run it.
-
A basic AsciiDoc file: Generating HTML out of a basic AsciiDoc file.
-
Using python in AsciiDoc files: Using python code to generate parts of your documentation.
-
Multipage documents: Splitting the HTML output into multiple pages with convenient navigation.
-
Packages: Separating documentation in packages.
-
Including API reference: Add API reference documentation extracted from source code.
-
Custom templates: Customize the generated output of AsciiDoxy with your own templates.
-
Stylesheets: Using stylesheets to customize the HTML output.