Navigation Menu

Skip to content

JGrenier/asciidoclet-sample

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

asciidoclet-sample

A simple sample project to demonstrate the use of asciidoc on a java project

key points

When adding a diagram, don’t forget to specify the location where asciidoctor-diagram have to render them.
If not specified, the picture will be generated in the root project dir which is not good.
In fact, these generated files would not be taken into account when calling the clean task on the project.

Example 1. Insertion d’un diagramme plantUml
/*
* [[plantuml]]
* .Diagramme de classe
* [plantuml, "build/tmp/javadoc/class", "png", align="center"]
* ---------------------------------------------------------------------
* AbstractHandler <|-- Handler
* AbstractHandler ..> Object
* ---------------------------------------------------------------------
*
*/

The file class.png will be generated in the folder build/tmp/javadoc.

  • [plantuml, "class", "png", align="center"]

The file class.png will be generated in the root project folder.

Warning

The folder specified has to be created before.

clone

clone the project.

git clone https://github.com/JGrenier/asciidoclet-sample.git

build

gradle clean javadoc

the javadoc is produced in asciidoclet-sample/build/docs

About

A simple sample project to demonstrate the use of asciidoc on a java project

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages