NAME
asciidoc-down - Convert AsciiDoc to Markdown
SYNOPSIS
asciidoc-down [OPTION]... FILE
DESCRIPTION
asciidoc-down reads AsciiDoc input and writes Markdown output.
FILE may be a path or - for stdin.
By default, output is written beside the input using the same base name with a .md extension. Use -o or --output to override this or use - for stdout.
OPTIONS
- -a, --attribute name=value
-
Set a runtime AsciiDoc attribute. Repeatable.
- -o, --output path|-
-
Write output to path or to stdout when set to
-. - --prepublish
-
Prepare local docs for publication in repositories where source AsciiDoc files should not be visible after conversion.
Behavior:
1. Converts the input (default
README.adoc) to Markdown. 2. Renames the source AsciiDoc file to a hidden path in the same directory (for exampleREADME.adocbecomes.README.adoc).Use this when you want generated Markdown checked/published while temporarily hiding the source AsciiDoc file.
If your document uses conditional environment attributes, pass them explicitly with
--attribute. For example:--attribute env=npm --attribute env-npmor for Perl-oriented conditionals:
--attribute env=perl --attribute env-perl - --postpublish
-
Undo the
--prepublishworkflow after publication.Behavior:
1. Restores the hidden source file (for example
.README.adocback toREADME.adoc). 2. Removes the generated Markdown output file.Use this to return the repository to its normal authoring state after a publish/release step.
- -h, --help
-
Show short usage help.
- --man
-
Show full man-page style help.
- -v, --version
-
Show version number.
EXIT STATUS
Returns 0 on success. Errors are reported to stderr and return non-zero.