README.adoc

Template para documentos (escritos em AsciiDoc e gerados com o Maven)

Este é um template simples para a criação de documentos utilizando o Maven e o AsciidoctorJ.

Utilização

Os documentos neste repositório são escritos no formato AsciiDoc e gerados, para a apresentação final, nos formatos HTML e PDF. A geração dos docs nesses últimos formatos é realizada pelo Maven, utilizando o AsciidoctorJ e o Asciidoctor Maven Plugin, ao invocar a goal process-resources (que está configurada para ser a default goal no pom.xml:

$ mvn

Após a execução do comando acima, os documentos (doc1.[html|pdf]) estarão disponíveis no diretório target/docs/, na seguinte estrutura de diretórios:

$ tree target/
target/
`-- docs
    |-- html
    |   |-- asciidoctor.css
    |   |-- doc1.html
    |   `-- images
    |       `-- sunset.jpg
    `-- pdf
        `-- doc1.pdf

4 directories, 4 files

Observe o padrão de escrita do doc1.adoc e a sua organização, na seguinte árvore:

$ tree src/
src/
|-- docs
|   |-- doc1.adoc
|   `-- images
|       `-- sunset.jpg
`-- pdf-styles
    |-- doc1-theme.yml
    `-- logo.png

3 directories, 4 files