the AsciiDoc source (String, Array, Readable, or
file-like object with a .path property)
Optionaloptions: objecta plain Object of options (mirrors Ruby API):
to_file {string|boolean|object} - String path, Boolean, stream object, or '/dev/null'to_dir {string} - output directorymkdirs {boolean} - create missing directories if truestandalone {boolean} - include header/footerheader_footer {boolean} - deprecated alias for standalonebase_dir {string} - base directorythe Document if output was written to a file, otherwise the converted String
Parse the AsciiDoc source input into a Document and convert it to the specified backend format.
Accepts input as a Node.js Readable stream (or any object with a read() method), a String, or a String Array. If the input is a file-like object with a
.pathproperty, it is treated as a file: the output is written to a file adjacent to the input by default.If
to_fileis true or omitted and the input is a file-like object, the output is written next to the input file. Ifto_fileis a String path, the output is written there. Ifto_fileis false, the converted String is returned. Ifto_fileis'/dev/null', the document is loaded but neither converted nor written.