asciidoctor:tldr:3afdf

asciidoctor: Convert a specific `.adoc` file to embeddable HTML, removing everything except the body.

asciidoctor

$ asciidoctor --embedded ${filename-adoc}

try on your machine

The command asciidoctor --embedded ${filename-adoc} is used to process or convert AsciiDoc files (files with a .adoc or .asciidoc extension) into other formats, such as HTML or PDF.

Here is a breakdown of the command:

asciidoctor: This is the command used to run the AsciiDoctor tool. AsciiDoctor is a text processor and publishing tool that converts AsciiDoc files into various output formats.
--embedded: This is an option or flag passed to the asciidoctor command. In this case, the --embedded flag specifies that the conversion should be done with the embedded (or inline) backend, which is used to generate a self-contained output file.
${filename-adoc}: This is a placeholder for the input AsciiDoc file name. The ${filename-adoc} part should be replaced with the actual file name (including the .adoc or .asciidoc extension) that you want to convert. For example, if the file you want to convert is called "example.adoc", the command would become asciidoctor --embedded example.adoc.

By running this command in a terminal or command prompt, the AsciiDoctor tool will process the specified AsciiDoc file using the embedded backend, and generate an output file in the format defined by the AsciiDoctor attributes within the file, such as HTML, PDF, or others.

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