diff --git a/todolist/asciidocs/docs/README.adoc b/todolist/asciidocs/docs/README.adoc new file mode 100644 index 0000000000000000000000000000000000000000..f1928f4554cb76ac4a7d7b67f992af2637694ca0 --- /dev/null +++ b/todolist/asciidocs/docs/README.adoc @@ -0,0 +1,11 @@ += todo-list-eksempel + +== Forord + +Denne modulen i todo-list-eksemplet inneholder dokumentasjon tenkt brukt som læringsmateriell, +ikke vanlig doumentasjon rettet mot utviklere av den typen en forventer i tilsvarende prosjekter. + +Dokumentasjonen er skrevet med https://asciidoctor.org/[Asciidoctor] og +bygget med image:images/maven-logo-black-on-white.png[Maven logo,60,link="https://maven.apache.org/"] + +== Introduksjon diff --git a/todolist/asciidocs/docs/images/maven-logo-black-on-white.png b/todolist/asciidocs/docs/images/maven-logo-black-on-white.png new file mode 100644 index 0000000000000000000000000000000000000000..2c1bfaa9f3c9af18ad00a62ecff0627ce8bf7f41 Binary files /dev/null and b/todolist/asciidocs/docs/images/maven-logo-black-on-white.png differ diff --git a/todolist/asciidocs/pom.xml b/todolist/asciidocs/pom.xml new file mode 100644 index 0000000000000000000000000000000000000000..d6ab33d9b423414691f40756fcfd6e7eb17afe1a --- /dev/null +++ b/todolist/asciidocs/pom.xml @@ -0,0 +1,73 @@ +<?xml version="1.0" encoding="UTF-8" ?> + +<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> + + <!-- + current a standalone module + <parent> + <groupId>it1901.todolist</groupId> + <artifactId>parent</artifactId> + <version>0.0.1-SNAPSHOT</version> + </parent> + --> + <groupId>it1901.todolist</groupId> + <artifactId>asciidocs</artifactId> + <version>0.0.1-SNAPSHOT</version> + + <dependencies> + </dependencies> + <build> + <plugins> + <plugin> + <groupId>org.asciidoctor</groupId> + <artifactId>asciidoctor-maven-plugin</artifactId> + <version>2.1.0</version> + <!-- + <version>1.5.6</version> + --> + + <configuration> + <sourceDirectory>docs</sourceDirectory> + <imagesDir>images</imagesDir> + <outputDirectory>target/asciidoc</outputDirectory> + <preserveDirectories>true</preserveDirectories> + <backend>html5</backend> + <sourceHighlighter>highlight.js</sourceHighlighter> + <attributes> + <toc>left</toc> + <sectnums>false</sectnums> + <project-version>${project.version}</project-version> + </attributes> + <resources> + <resource> + <!-- (Mandatory) Directory to copy from. Paths are relative to maven's ${baseDir} --> + <directory>docs/images</directory> + <!-- (Optional) Directory to copy to. By default uses the option `outputDirectory` --> + <targetPath>images</targetPath> + <!-- (Optional) NOTE: SVN, GIT and other version control files are excluded by default, there's no need to add them --> + <excludes> + <exclude>**/.txt</exclude> + </excludes> + <!-- (Optional) If not set, includes all files but default exceptions mentioned --> + <includes> + <include>**/*.png</include> + <include>**/*.jpg</include> + </includes> + </resource> + </resources> + </configuration> + + <executions> + <execution> + <id>generate-html</id> + <phase>generate-resources</phase> + <goals> + <goal>process-asciidoc</goal> + </goals> + </execution> + </executions> + </plugin> + </plugins> + </build> +</project> \ No newline at end of file