diff --git a/devtools/config-doc-maven-plugin/src/main/java/io/quarkus/maven/config/doc/generator/MarkdownFormatter.java b/devtools/config-doc-maven-plugin/src/main/java/io/quarkus/maven/config/doc/generator/MarkdownFormatter.java index 425e7481134fe..c4572873817fd 100644 --- a/devtools/config-doc-maven-plugin/src/main/java/io/quarkus/maven/config/doc/generator/MarkdownFormatter.java +++ b/devtools/config-doc-maven-plugin/src/main/java/io/quarkus/maven/config/doc/generator/MarkdownFormatter.java @@ -19,15 +19,7 @@ protected JavadocFormat javadocFormat() { @Override public String formatSectionTitle(ConfigSection configSection) { - // markdown only has 6 heading levels - int headingLevel = Math.min(6, 2 + configSection.getLevel()); - return "#".repeat(headingLevel) + " " + super.formatSectionTitle(configSection); - } - - @Override - public String escapeCellContent(String value) { - String cellContent = super.escapeCellContent(value); - return cellContent == null ? null : cellContent.replace("\n\n", "

").replace("\n", " "); + return " ".repeat(configSection.getLevel() * 4) + super.formatSectionTitle(configSection); } @Override diff --git a/devtools/config-doc-maven-plugin/src/main/resources/templates/markdown/default/allConfig.qute.md b/devtools/config-doc-maven-plugin/src/main/resources/templates/markdown/default/allConfig.qute.md index 5b89612f0fa23..5a95faabc7eeb 100644 --- a/devtools/config-doc-maven-plugin/src/main/resources/templates/markdown/default/allConfig.qute.md +++ b/devtools/config-doc-maven-plugin/src/main/resources/templates/markdown/default/allConfig.qute.md @@ -4,8 +4,15 @@ # {extensionConfigRootsEntry.key.formatName} -| Configuration property | Type | Default | -|------------------------|------|---------| + + + + + + + + + {#for configRoot in extensionConfigRootsEntry.value.values} {#for item in configRoot.items} {#if !item.deprecated} @@ -17,6 +24,8 @@ {/if} {/for} {/for} + +
Configuration propertyTypeDefault
{/for} {#if includeDurationNote} diff --git a/devtools/config-doc-maven-plugin/src/main/resources/templates/markdown/default/configReference.qute.md b/devtools/config-doc-maven-plugin/src/main/resources/templates/markdown/default/configReference.qute.md index 3c5237e397e66..a11b56f425e12 100644 --- a/devtools/config-doc-maven-plugin/src/main/resources/templates/markdown/default/configReference.qute.md +++ b/devtools/config-doc-maven-plugin/src/main/resources/templates/markdown/default/configReference.qute.md @@ -1,16 +1,22 @@ 🔒: Configuration property fixed at build time - All other configuration properties are overridable at runtime -{#if configItemCollection.nonDeprecatedProperties} -| Configuration property | Type | Default | -|------------------------|------|---------| + + + + + + + + + {#for property in configItemCollection.nonDeprecatedProperties} {#configProperty configProperty=property extension=extension additionalAnchorPrefix=additionalAnchorPrefix /} {/for} -{/if} {#for section in configItemCollection.nonDeprecatedSections} - {#configSection configSection=section extension=extension additionalAnchorPrefix=additionalAnchorPrefix displayConfigRootDescription=false /} {/for} + +
Configuration propertyTypeDefault
{#if includeDurationNote} {#durationNote summaryTableId /} diff --git a/devtools/config-doc-maven-plugin/src/main/resources/templates/markdown/default/tags/configProperty.qute.md b/devtools/config-doc-maven-plugin/src/main/resources/templates/markdown/default/tags/configProperty.qute.md index ce0462b7b2ce1..0980471bd8986 100644 --- a/devtools/config-doc-maven-plugin/src/main/resources/templates/markdown/default/tags/configProperty.qute.md +++ b/devtools/config-doc-maven-plugin/src/main/resources/templates/markdown/default/tags/configProperty.qute.md @@ -1 +1,21 @@ -| {#if configProperty.phase.fixedAtBuildTime}🔒 {/if}`{configProperty.path.property}`{#for additionalPath in configProperty.additionalPaths}
`{additionalPath.property}`{/for}

{configProperty.formatDescription.escapeCellContent.or("")}{#envVar configProperty /} | {configProperty.formatTypeDescription.escapeCellContent.or("")} | {#if configProperty.defaultValue}{configProperty.formatDefaultValue.escapeCellContent}{/if} | + + + +{#if configProperty.phase.fixedAtBuildTime}🔒 {/if}`{configProperty.path.property}` +{#for additionalPath in configProperty.additionalPaths} +`{additionalPath.property}` +{/for} + +{configProperty.formatDescription.escapeCellContent.or("")} + +{#envVar configProperty /} + + + +{configProperty.formatTypeDescription.escapeCellContent.or("")} + + + +{#if configProperty.defaultValue}{configProperty.formatDefaultValue.escapeCellContent}{/if} + + diff --git a/devtools/config-doc-maven-plugin/src/main/resources/templates/markdown/default/tags/configSection.qute.md b/devtools/config-doc-maven-plugin/src/main/resources/templates/markdown/default/tags/configSection.qute.md index 69f5a2012af94..5d518fff7930e 100644 --- a/devtools/config-doc-maven-plugin/src/main/resources/templates/markdown/default/tags/configSection.qute.md +++ b/devtools/config-doc-maven-plugin/src/main/resources/templates/markdown/default/tags/configSection.qute.md @@ -1,13 +1,14 @@ + + + {configSection.formatTitle} + + + -{#if configSection.nonDeprecatedProperties} -| Configuration property | Type | Default | -|------------------------|------|---------| {#for property in configSection.nonDeprecatedProperties} {#configProperty configProperty=property extension=extension additionalAnchorPrefix=additionalAnchorPrefix /} {/for} -{/if} {#for subsection in configSection.nonDeprecatedSections} - {#configSection configSection=subsection extension=extension additionalAnchorPrefix=additionalAnchorPrefix /} -{/for} \ No newline at end of file +{/for}