Quickstart
There are several ways to get quickly started with the Docs-as-Code approach.
The Quickstart basically consists of creating and rendering your first AsciiDoc document.
The Zero-Dependencies Approach
You just want to give AsciiDoc a try without installing anything?
Go to AsciiDocLIVE and use an online editor with preview.
The Editor Approach
If you are willing to install an editor or a plugin for your favorite IDE, you can install one of the following editors with the corresponding plugins:
⇒ see also our German article about Tools for AsciiDoc
The Build-Tool Approach
"You are standing in an open field west of a white house, with a boarded front door."[1]
There is a Maven, a Gradle and a Command-Line-Tool nearby.
What will you choose?
You install asciidoctorj via sdkman and write your first simple AsciiDoc document
== Headline
first paragraph
second paragraph
=== second level headline
a link: https://docs-as-co.de[docs-as-co.de]
You then convert it via
asciidoctorj test.adoc
you are likely to be eaten by a grue.
You install Maven via sdkman and write your first simple AsciiDoc document
== Headline
first paragraph
second paragraph
=== second level headline
a link: https://docs-as-co.de[docs-as-co.de]
You then download the build file from github, because it is too big to be just typed in:
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>docs-as-co.de</groupId>
<artifactId>asciidocTest</artifactId>
<version>0.1</version>
<build>
<defaultGoal>generate-resources</defaultGoal>
<plugins>
<plugin>
<groupId>org.asciidoctor</groupId>
<artifactId>asciidoctor-maven-plugin</artifactId>
<version>1.5.6</version>
<configuration>
<backend>html5</backend>
</configuration>
<executions>
<execution>
<id>output-html</id>
<phase>generate-resources</phase>
<goals>
<goal>process-asciidoc</goal>
</goals>
</execution>
</executions>
</plugin>
</plugins>
</build>
</project>
…and convert your document via
mvn asciidoc
Good choice! A fairy appears and grants you a wish. You wish for a very simple build file and the following line of text appears:
plugins { id "org.asciidoctor.convert" version "1.5.3" }
you write your very first AsciiDoc document and put it in /src/docs/asciidoc/
== Headline
first paragraph
second paragraph
=== second level headline
a link: https://docs-as-co.de[docs-as-co.de]
You install Gradle via sdkman and convert the file with
gradle asciidoc
a nicely styled html file appears in /build/asciidoc/html5/.