diff options
Diffstat (limited to 'docs/modules/get-started')
| -rw-r--r-- | docs/modules/get-started/nav.adoc | 1 | ||||
| -rw-r--r-- | docs/modules/get-started/pages/index.adoc | 50 |
2 files changed, 51 insertions, 0 deletions
diff --git a/docs/modules/get-started/nav.adoc b/docs/modules/get-started/nav.adoc new file mode 100644 index 00000000..31f850ee --- /dev/null +++ b/docs/modules/get-started/nav.adoc @@ -0,0 +1 @@ +* xref:index.adoc[] diff --git a/docs/modules/get-started/pages/index.adoc b/docs/modules/get-started/pages/index.adoc new file mode 100644 index 00000000..89b0bee1 --- /dev/null +++ b/docs/modules/get-started/pages/index.adoc @@ -0,0 +1,50 @@ += Convert Your First AsciiDoc File +:navtitle: Convert Your First File + +Assumptions: + +- [x] You've installed Asciidoctor. +- [x] You've confirmed that the Asciidoctor command line interface (CLI) is available on your PATH. + +On this page, you'll learn how to run Asciidoctor on an AsciiDoc document and convert it to HTML. + +== Generate HTML using the default converter + +Let's generate HTML 5 using Asciidoctor's default converter and stylesheet from an AsciiDoc document. +If you want to follow along with the examples, #download the _my-sample.adoc_ file# or use your own AsciiDoc document. + +. Open a terminal and switch (`cd`) into the directory where your AsciiDoc document is saved. + + $ cd directory-name + +. Call Asciidoctor with the `asciidoctor` command, followed by file name of the AsciiDoc document. +Since HTML 5 is Asciidoctor's default output, we don't need to specify a converter. ++ +-- + $ asciidoctor my-sample.adoc + +As long as the document didn't contain any syntax errors, you won't see any messages printed to your terminal. +-- + +. Type `ls` to list the files in the directory. ++ +-- + $ ls + my-sample.adoc my-sample.html + +You should see a new file named [.path]_my-sample.html_. +Asciidoctor derives the name of the output file from the name of the input document. +-- + +. Open [.path]_my-sample.html_ in your web browser. +The converted document should look like the example below. ++ +==== +#fix ex# +//image::mysample.png[] +==== ++ +The document's text, titles, and link is styled by the default Asciidoctor stylesheet, which is embedded in the HTML output. +As a result, you could save [.path]_my-sample.html_ to any computer and it will look the same. + +TIP: Most of the examples in the general documentation use the CLI, but there are usually corresponding API examples under Working with the API. |