id = "asciidoc"
name = "AsciiDoc"
homepage = "https://asciidoc-py.github.io/"
description = "A text document format for writing notes, documentation, articles, books, slides and man pages."
executables = ["asciidoc", "a2x"]
platforms = ["macos", "linux"]
[dotfiles]
paths = ["~/.asciidoc/"]
secret = []
side_effect = false
[commands]
format = 1
label = "Convert AsciiDoc"
description = "Convert one AsciiDoc file to HTML or DocBook with asciidoc. The a2x wrapper and plugin commands are left out."
quality = "ai-draft"
parser = { end_of_options = "--", interleave = "permute", long_equals = true, short_attached = true, short_bundles = false }
[[commands.source]]
id = "help"
kind = "manual"
url = "https://github.com/asciidoc-py/asciidoc-py/blob/master/asciidoc/resources/help.conf"
revision = "master 2026-10-27"
evidence = """
asciidoc [OPTIONS] FILE
-a, --attribute=ATTRIBUTE
-b, --backend=BACKEND
Backend output file format: docbook45, xhtml11, html4, html5,
slidy, wordpress or latex (the latex backend is experimental).
-d, --doctype=DOCTYPE
Document type: article, manpage or book.
-s, --no-header-footer
Suppress document header and footer output.
-o, --out-file=OUT_FILE
-n, --section-numbers
Auto-number HTML article section titles.
-v, --verbose
"""
[[commands.field]]
id = "file"
label = "Input file"
description = "Use - to read standard input."
type = "path"
path = { kind = "file", role = "input" }
position = 0
sources = ["help"]
[[commands.field]]
id = "backend"
label = "Backend"
type = "enum"
choices = [{ value = "docbook45", label = "DocBook 4.5" }, { value = "xhtml11", label = "XHTML 1.1" }, { value = "html4", label = "HTML 4" }, { value = "html5", label = "HTML 5" }, { value = "slidy", label = "Slidy slides" }, { value = "wordpress", label = "WordPress" }, { value = "latex", label = "LaTeX (experimental)" }]
option = ["--backend", "-b"]
sources = ["help"]
[[commands.field]]
id = "doctype"
label = "Document type"
type = "enum"
choices = [{ value = "article", label = "Article" }, { value = "manpage", label = "Man page" }, { value = "book", label = "Book" }]
option = ["--doctype", "-d"]
sources = ["help"]
[[commands.field]]
id = "out_file"
label = "Output file"
type = "path"
path = { kind = "file", role = "output" }
option = ["--out-file", "-o"]
effect = "overwrite"
sources = ["help"]
[[commands.field]]
id = "attribute"
label = "Attributes"
description = "NAME=VALUE; repeatable."
type = "string"
option = ["--attribute", "-a"]
multiple = true
sources = ["help"]
[[commands.field]]
id = "section_numbers"
label = "Number sections"
type = "boolean"
option = ["--section-numbers", "-n"]
sources = ["help"]
[[commands.field]]
id = "no_header_footer"
label = "No header and footer"
type = "boolean"
option = ["--no-header-footer", "-s"]
sources = ["help"]
[[commands.field]]
id = "verbose"
label = "Verbose"
type = "boolean"
option = ["--verbose", "-v"]
sources = ["help"]
[[commands.task]]
id = "html"
label = "Convert to HTML 5"
set = { backend = ["html5"] }
fields = ["file", "backend", "out_file", "section_numbers", "attribute"]
required = ["file"]
[[commands.task]]
id = "manpage"
label = "Build a man page"
set = { backend = ["docbook45"], doctype = ["manpage"] }
fields = ["file", "backend", "doctype", "out_file"]
required = ["file"]
[[commands.group]]
id = "basic"
label = "Basic"
fields = ["file", "backend", "doctype", "out_file"]
[[commands.group]]
id = "advanced"
label = "Advanced"
fields = ["attribute", "section_numbers", "no_header_footer", "verbose"]
