Skip to content

Commit 25b952f

Browse files
authored
[DOC] improve html rendering (#191)
- toc: only display 2 levels. Previously, it was set to '5' which is too much for now as we do not have a lot of content - set numeration also on deep sections. We previously stopped at 2, so sections like 'XML Parser' were un-numerated - fix title of sections about 'BPMN Support'. Previous wording was too long and contained useless words (' Description of the') - supported BPMN elements: remove 'page' words. Even if the AsciiDoctor source is in a single file/page, it is intended to be included in a single html doc, so 'page' is not accurate here.
1 parent 58711bc commit 25b952f

File tree

3 files changed

+7
-7
lines changed

3 files changed

+7
-7
lines changed

docs/bpmn-support-roadmap.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[[bpmn-support-roadmap]]
22

3-
== Description of the BPMN support Roadmap
3+
== BPMN Support Roadmap
44
:icons: font
55

66
NOTE: The list of supported BPMN elements is available in <<supported-bpmn-elements,supported BPMN elements>>

docs/bpmn-support.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
[[supported-bpmn-elements]]
22

3-
== Description of the supported BPMN elements
3+
== Supported BPMN Elements
44
:icons: font
55

66
NOTE: The support roadmap is available in <<bpmn-support-roadmap,BPMN Support Roadmap>>
77

88

9-
This page presents BPMN elements that can be displayed by the lib and states which is their rendering status i.e. if the
10-
BPMN elements are rendered with their final shapes.
9+
The following presents BPMN elements that can be displayed by the lib and states which is their rendering status i.e. if
10+
the BPMN elements are rendered with their final shapes.
1111

1212
The default rendering uses `white` as fill color and `black` as stroke color.
1313

docs/index.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,13 @@
22
:toc: left
33
// see: https://asciidoctor.org/docs/user-manual/#table-of-contents-summary
44
:toc-title: Table of Contents
5-
// how many headline levels to display in table of contents?
6-
:toclevels: 5
5+
// how many headline levels to display in the table of contents?
6+
:toclevels: 2
77
// https://asciidoctor.org/docs/user-manual/#sections-summary
88
// turn numbering on or off (:sectnums!:)
99
:sectnums:
1010
// enumerate how many section levels?
11-
:sectnumlevels: 2
11+
:sectnumlevels: 5
1212
// show anchors when hovering over section headers
1313
:sectanchors:
1414
// render section headings as self referencing links

0 commit comments

Comments
 (0)