@@ -80,11 +80,16 @@ https://jgiven.org/jgiven-report/html5/[HTML report of JGiven itself]
8080
8181=== AsciiDoc Report
8282
83+ [CAUTION]
84+ ====
85+ The generator for AsciiDoc reports is currently still in an experimental phase.
86+ Not all functions of the HTML report are supported.
87+ ====
88+
8389To generate an AsciiDoc report you have to run the JGiven report generator with the `asciidoc` format option.
8490The report generator can be executed on the command line as follows
8591(assuming that the `jgiven-core` JAR and all required dependencies are on the Java CLASSPATH)
8692
87-
8893[source,console]
8994----
9095$ java com.tngtech.jgiven.report.ReportGenerator \
@@ -126,32 +131,38 @@ For Maven there exists a plugin that can be used as follows:
126131You can add the following configuration options (like the _format_ configuration above) to customize the report.
127132All of them are optional.
128133
129- [cols="1,3" ]
134+ [%autowidth ]
130135.Configuration Options for Reports
131136|===
132- |Option |Description
137+ |Option |Default value | Description
133138
134139|format
135- |The format of the generated report. Can be _html_, _text_ or _asciidoc_. Default: _html_
140+ |`html`
141+ |The format of the generated report. Can be _html_, _text_ or _asciidoc_.
136142
137143|title
138- |The title of the generated report. Default: _JGiven Report_
144+ |`JGiven Report`
145+ |The title of the generated report.
139146
140147|customCssFile
141- |Custom CSS file to customize the HTML report. Default: _src/test/resources/jgiven/custom.css_
148+ |`src/test/resources/jgiven/custom.css`
149+ |Custom CSS file to customize the HTML report.
142150
143151|customJsFile
144- |Custom JS file to customize the HTML report. Default: _src/test/resources/jgiven/custom.js_
152+ |`src/test/resources/jgiven/custom.js`
153+ |Custom JS file to customize the HTML report.
145154
146155|excludeEmptyScenarios
147- |Whether or not to exclude empty scenarios, i.e. scenarios without any steps, from the report. Default: _false_
156+ |`false`
157+ |Whether or not to exclude empty scenarios, i.e. scenarios without any steps, from the report.
148158
149159|outputDirectory
150- |Directory where the reports are generated to. Default: _${project.build.directory}/jgiven-reports/html_
160+ |`${project.build.directory}/jgiven-reports/html`
161+ |Directory where the reports are generated to.
151162
152163|sourceDirectory
153- |Directory to read the JSON report files from. Default: _ ${project.build.directory}/jgiven-reports/json_
154-
164+ |` ${project.build.directory}/jgiven-reports/json`
165+ |Directory to read the JSON report files from.
155166|===
156167
157168Now run:
0 commit comments