Forrest logo
back to the asciidoctor tool


asciidoctor: Convert a specific `.adoc` file to HTML (the default output format).
$ asciidoctor ${filename-adoc}
try on your machine

The command asciidoctor ${filename-adoc} is a command-line instruction that uses the asciidoctor command to convert AsciiDoc files into HTML or other supported formats.

Here is a breakdown of the command:

  • asciidoctor: This is the main command that executes the AsciiDoctor tool. AsciiDoctor is a text processor and publishing tool used to convert AsciiDoc documents into different outputs.
  • ${filename-adoc}: This is a placeholder for the actual filename and extension of the AsciiDoc file that you want to convert. The ${filename-adoc} syntax suggests that you should replace it with the actual filename and extension of the AsciiDoc file, for example, document.adoc. The .adoc extension is commonly used for AsciiDoc files.

When you run this command by substituting ${filename-adoc} with the actual filename, the AsciiDoctor tool will process the specified AsciiDoc file and convert it into the desired output format, such as HTML.

For example, if you have an AsciiDoc file named document.adoc and you execute the command asciidoctor document.adoc, it will convert the document.adoc file into the default output format, which is usually HTML, and you will get an document.html file as the result.

This explanation was created by an AI. In most cases those are correct. But please always be careful and never run a command you are not sure if it is safe.
back to the asciidoctor tool