HTML Help Generators

The HTML help generator is provided by the airline-help-html library. It provides a help generator implementation that can be used to generate help in HTML format that can be viewed in a web browser.

Available Implementations

The following implementations are available:

HtmlCommandUsageGenerator - Help

Example Usage

Command Help

Using HtmlCommandUsageGenerator:

SingleCommand<Price> command = new SingleCommand<Price>(Price.class);

CommandUsageGenerator generator = new HtmlCommandUsageGenerator();
try {
    generator.usage(null, null, "price", command.getCommandMetadata(), command.getParserConfiguration(), System.out);
} catch (IOException e) {
    e.printStackTrace();
}

Customisation

The main piece of customisation for HTML help generators is what stylesheets to use, by default the HTML generated assumes Bootstrap is used as a stylesheet. If you wish to use alternative stylesheets then you can do so e.g.

CommandUsageGenerator = new HtmlCommandUsageGenerator("css/my-style.css");

Improving this Documentation

This documentation is itself open source and lives in GitHub under the docs/ directory.