2 minutes to read
This appendix covers all configuration introduced by docToolchain. AsciiDoc, AsciiDoctor, Gradle and other tools and libraries used know of more configuration settings and you can read about those in the corresponding documentation.
docToolchain should be easy to use. That’s why the goal is to have one config file with all settings for each project. But first of all, docToolchain has to know where your documentation project is located.
docDir is defined, the default for
Config.groovy in the root folder of your
You have several options to specify the location of your documentation project (
docDir) and the location of your config file (
Specify the property on the commandline
./dtcw generateHTML -PmainConfigFile=Config.groovy
you can verify the location of your
Config.groovy by executing docToolchain with the
--info parameter which sets the loglevel to
It will print the location on the command line (among other settings)
dynamic configuration properties
Sometimes you need a more dynamic configuration.
Since the configuration file is an executable
.groovy file, you can not only configure static values but also fetch dynamic once.
example = System.properties.myProperty
You can then specify the property with the
-D parameter like this
./dtcw docker generateHTML -DmyProperty=myValue
In the same way, you can use environment variables
example = System.getenv("myEnvVariable")
But in this case, you have to ensure that the environment variable can be accessed.
It will not work for docker based execution of
Content of the
Unresolved directive in <stdin> - include::../../../Config.groovy[tags=**]
Command Line Parameters
Was this page helpful?
Glad to hear it! Please tell us how we can improve.
Sorry to hear that. Please tell us how we can improve.