search

rodnansol / spring-configuration-property-documenter

Tool to document Spring Configuration Properties - Leave us a feedback: https://github.com/rodnansol/spring-configuration-property-documenter/discussions/74
Apache License 2.0
39 stars 5 forks source link

Introduce compact mode #59

Closed nandorholozsnyak closed 1 year ago

nandorholozsnyak commented 1 year ago

Is your feature request related to a problem? Please describe. With the current templates all the different property groups are having their own sections and the different properties are always under their group's main section.

It is fine, this was the initial idea, but there could be a new template that would just list all the available properties without any property groups.

Describe the solution you'd like Introduce a new compact mode which will list only the available configuration properties.

Allsimon commented 1 year ago

Compact mode looks great, there is an issue when customizing "headerTemplate":

<configuration>
    <type>ADOC</type>
    <headerTemplate>src/main/resources/templates/header.adoc</headerTemplate>
    <asciiDocCustomization>
        <templateMode>COMPACT</templateMode>
    </asciiDocCustomization>

the header of the table isn't generated anymore (not sure if it's on purpose 🤔 ):

[cols="2,1,3,1,1"]
|===
|Key |Type |Description |Default value |Deprecation
nandorholozsnyak commented 1 year ago

Hey @Allsimon

Yes it was on purpose, because when you are aggregating different documents, all the different keys must be put into one big table, of course it can be a topic of a debate, but I can imagine a compact mode (another one) where the different metadata files are rendered into different tables, not in a big one.

Right now you can check the current templates for more information, I think you should be able to use an include in your own header template as well.