The hazelcast-reference-manual from puzpuzpuz

hazelcast-reference-manual's Introduction

Hazelcast IMDG Reference Manual

Building the Documentation

Following command is used to build the document in the repo’s root folder.

./gradlew build

Where Are the Generated Documents

The resulting documents can be found in build/asciidoc/.

How to Produce Different Output Formats

In the file build.gradle, you will see the "backends" tag:

backends = [ 'html5', /*'pdf',*/ /* 'multipage_html5',*/ /*'epub3'*/ ]

In this line, you can comment out (using /* and */) the formats that you do not want the generator to produce.

How to Add a New Chapter

In the file build.gradle, you will see the "sources" tag:

sources {
    include 'index.adoc'
}

The file index.adoc is the one which includes the chapters in the given order and also some parameters. It is located in the folder src/docs/asciidocs/.

When you want to add a new chapter, just create a text file (the extension of the file must be adoc) in the folder src/docs/asciidocs/ and add the name of the file to index.adoc.

How to Add Tabbed Source Code Block

Here is an example 2-tabbed block; XML and Java:

[source,xml,indent=0,subs="verbatim,attributes",role="primary"]
.XML
----
<XML code here>
----

[source,java,indent=0,subs="verbatim,attributes",role="secondary"]
.Java
----
<Java code here>
----

You can add more tabs simply by adding the "secondary" role snippet as much as you want.