Getting Started
|
Note
|
This page is currently under construction and will describe how you can start easily with a new document. etc. |
The editor is just an editor, but with some nice toolbar actions, code completion, syntax highlighting and .. last but not least a great preview function.
Please see FAQ
HINT: You can use the editor in any perspective or project you like!
See YouTube Video for a short intro how to create simple standalone asciidoc files with editor
When you want to document your software project in a modern and agile way (IMHO) this is the correct setup:
-
Use same repository as your software project for code and documentation. So when you check out a tag /version of your code you will always get the corresponding documentation for it…
-
Document always only in a text format and do NOT use any binary format (e.g. word etc.). Of course I prefer
asciidoctor. -
Integrate documentation into your CI tool chain. For asciidoctor I prefer https://asciidoctor.org/docs/asciidoctor-gradle-plugin/
-
Use an editor which does a fast preview which is nearly the same as your documentation outcome of your builde chain (asciidoctor editor does this)
-
Use multi project structures and create an own sub project containing documentation only. Maven and Gradle are giving great support for it.
-
Use includes and seperate at least chapters into own files. If you want to have a very good template you can try out https://arc42.org/ . Look into the download section for the asciidoc variant. Just unzip the files and you got full structured documentation setup ready to start
With EGradle 2.5 there is a new template introduced : java-full-multiproject-with-asciidoctor (see #346 for details)
Using EGradle New project wizard with this template you will have a full working, out-of-the-box multi project setup with chapters, includes, examples and also a full working gradle setup.
Just call gradlew asciidoctor and you got the generated output - you will find the content inside `build/
Take a look at https://github.com/de-jcup/eclipse-asciidoctor-editor/tree/master/asciidoctor-editor-other/testscripts for some examples.