stove/rougail-output-doc
2
0
Fork 0
Code Issues 1 Pull requests Projects Releases Packages Wiki Activity
rougail-output-doc/README.md

177 lines
75 KiB
Markdown
Raw Normal View History

feat: personalise column number
2025-11-29 22:21:06 +01:00
# Générer la documentation
feat: document commandline and environment variable
2025-11-27 22:17:17 +01:00
> **🛈 Informations**
>
> **<a id="doc" name="doc">doc</a>**\
feat: personalise column number
2025-11-29 22:21:06 +01:00
> `basic` *`désactivé`*\
> **Désactivé** : lorsque "[Générer la documentation](#doc)" n'est pas spécifié dans "[Sélection pour sortie](#step.output)"
feat: document commandline and environment variable
2025-11-27 22:17:17 +01:00
feat: personalise column number
2025-11-29 22:21:06 +01:00
| Variable | Description |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **<a id="doc.title_level" name="doc.title_level">doc.title_level</a>**<br/>`integer` `standard` `obligatoire`<br/>**Ligne de commande** : -dt, <a id="doc.title_level" name="doc.title_level">--doc.title_level</a><br/>**Variable d'environnement** : <a id="doc.title_level" name="doc.title_level">ROUGAILCLI_DOC.TITLE_LEVEL</a> | Niveau de titre de départ.<br/>**Défaut** : 1 |
| **<a id="doc.contents" name="doc.contents">doc.contents</a>**<br/>`choice` `multiple` `standard` `obligatoire` `unique`<br/>**Ligne de commande** : -dc, <a id="doc.contents" name="doc.contents">--doc.contents</a><br/>**Variable d'environnement** : <a id="doc.contents" name="doc.contents">ROUGAILCLI_DOC.CONTENTS</a> | Contenu générer.<br/>**Choix** : <br/>•&nbsp;variables **← (défaut)**<br/>•&nbsp;example<br/>•&nbsp;changelog |
| **<a id="doc.previous_json_file" name="doc.previous_json_file">doc.previous_json_file</a>**<br/>`string` `basic` `obligatoire` *`désactivé`*<br/>**Ligne de commande** : -dp, <a id="doc.previous_json_file" name="doc.previous_json_file">--doc.previous_json_file</a><br/>**Variable d'environnement** : <a id="doc.previous_json_file" name="doc.previous_json_file">ROUGAILCLI_DOC.PREVIOUS_JSON_FILE</a> | Précédent fichier de description au format JSON.<br/>**Désactivé** : changelog n'est pas sélectionné dans "[Contenu générer](#doc.contents)" |
| **<a id="doc.without_family" name="doc.without_family">doc.without_family</a>**<br/>`boolean` `standard` `obligatoire` *`désactivé`*<br/>**Ligne de commande** : <br/>•&nbsp;-df, <a id="doc.without_family" name="doc.without_family">--doc.without_family</a><br/>•&nbsp;-ndf, --doc.no-without_family<br/>**Variable d'environnement** : <a id="doc.without_family" name="doc.without_family">ROUGAILCLI_DOC.WITHOUT_FAMILY</a> | Ne pas ajouter les familles dans la documentation.<br/>**Défaut** : false<br/>**Désactivé** : if "[Générer le document au format](#doc.output_format)" is json or "[Contenu générer](#doc.contents)" hasn't variable or changelog |
| **<a id="doc.root" name="doc.root">doc.root</a>**<br/>`string` `standard`<br/>**Ligne de commande** : -dr, <a id="doc.root" name="doc.root">--doc.root</a><br/>**Variable d'environnement** : <a id="doc.root" name="doc.root">ROUGAILCLI_DOC.ROOT</a> | Documente les variables depuis cette famille. |
| **<a id="doc.with_commandline" name="doc.with_commandline">doc.with_commandline</a>**<br/>`boolean` `standard` `obligatoire` *`désactivé`*<br/>**Ligne de commande** : <br/>•&nbsp;-dw, <a id="doc.with_commandline" name="doc.with_commandline">--doc.with_commandline</a><br/>•&nbsp;-ndw, --doc.no-with_commandline<br/>**Variable d'environnement** : <a id="doc.with_commandline" name="doc.with_commandline">ROUGAILCLI_DOC.WITH_COMMANDLINE</a> | Ajoute les informations de la ligne de commande dans la documentation.<br/>**Défaut** : false<br/>**Désactivé** : if "[Générer le document au format](#doc.output_format)" is json or "[Contenu générer](#doc.contents)" hasn't variable or changelog |
| **<a id="doc.with_environment" name="doc.with_environment">doc.with_environment</a>**<br/>`boolean` `standard` `obligatoire` *`désactivé`*<br/>**Ligne de commande** : <br/>•&nbsp;-de, <a id="doc.with_environment" name="doc.with_environment">--doc.with_environment</a><br/>•&nbsp;-nde, --doc.no-with_environment<br/>**Variable d'environnement** : <a id="doc.with_environment" name="doc.with_environment">ROUGAILCLI_DOC.WITH_ENVIRONMENT</a> | Ajoute les informations de variable d&#x27;environnement dans la documentation.<br/>**Défaut** : false<br/>**Désactivé** : if "[Générer le document au format](#doc.output_format)" is json or "[Contenu générer](#doc.contents)" hasn't variable or changelog |
| **<a id="doc.environment_default_environment_name" name="doc.environment_default_environment_name">doc.environment_default_environment_name</a>**<br/>`string` `standard` `obligatoire` *`désactivé`*<br/>**Ligne de commande** : -dd, <a id="doc.environment_default_environment_name" name="doc.environment_default_environment_name">--doc.environment_default_environment_name</a><br/>**Variable d'environnement** : <a id="doc.environment_default_environment_name" name="doc.environment_default_environment_name">ROUGAILCLI_DOC.ENVIRONMENT_DEFAULT_ENVIRONMENT_NAME</a> | Nom du préfixe d&#x27;environnement par défaut.<br/>**Validateur** : doit seulement utilise des caractères en majuscule<br/>**Défaut** : ROUGAIL<br/>**Désactivé** : si "__.main_namespace" n'est pas défini ou "[Ajoute les informations de variable d&#x27;environnement dans la documentation](#doc.with_environment)" est false |
feat: document commandline and environment variable
2025-11-27 22:17:17 +01:00
feat: personalise column number
2025-11-29 22:21:06 +01:00
# Les familles ou variables pour cette famille sont dans un autre fichier
feat: document commandline and environment variable
2025-11-27 22:17:17 +01:00
> **🛈 Informations**
>
> **<a id="doc.other_root_filenames" name="doc.other_root_filenames">doc.other_root_filenames</a>**\
feat: personalise column number
2025-11-29 22:21:06 +01:00
> Cette famille contient des listes de bloc de variable.\
> `basic` *`désactivé`*\
> **Désactivé** : documentation doit être séparée
| Variable | Description |
|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------|
| **<a id="doc.other_root_filenames.root_path" name="doc.other_root_filenames.root_path">doc.other_root_filenames.root_path</a>**<br/>`string` `multiple` `standard` `unique`<br/>**Ligne de commande** : <a id="doc.other_root_filenames.root_path" name="doc.other_root_filenames.root_path">--doc.other_root_filenames.root_path</a><br/>**Variable d'environnement** : <a id="doc.other_root_filenames.root_path" name="doc.other_root_filenames.root_path">ROUGAILCLI_DOC.OTHER_ROOT_FILENAMES.ROOT_PATH</a> | Nom de la famille racine. |
| **<a id="doc.other_root_filenames.filename" name="doc.other_root_filenames.filename">doc.other_root_filenames.filename</a>**<br/>`UNIX filename` `basic` `obligatoire`<br/>**Ligne de commande** : <a id="doc.other_root_filenames.filename" name="doc.other_root_filenames.filename">--doc.other_root_filenames.filename</a><br/>**Variable d'environnement** : <a id="doc.other_root_filenames.filename" name="doc.other_root_filenames.filename">ROUGAILCLI_DOC.OTHER_ROOT_FILENAMES.FILENAME</a> | Nom du fichier.<br/>**Validateurs** : <br/>•&nbsp;this filename could be a relative path<br/>•&nbsp;file type allowed: "fichier" et "répertoire" |
| Variable | Description |
|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **<a id="doc.disabled_modes" name="doc.disabled_modes">doc.disabled_modes</a>**<br/>`string` `multiple` `standard` *`désactivé`* `unique`<br/>**Ligne de commande** : <a id="doc.disabled_modes" name="doc.disabled_modes">--doc.disabled_modes</a><br/>**Variable d'environnement** : <a id="doc.disabled_modes" name="doc.disabled_modes">ROUGAILCLI_DOC.DISABLED_MODES</a> | Désactiver la documentation des variables avec ces modes.<br/>**Validateur** : vérifier le mode existe déjà<br/>**Désactivé** : désactiver lorsqu'il n'y a pas de mode valable |
| **<a id="doc.change_default_value" name="doc.change_default_value">doc.change_default_value</a>**<br/>`boolean` `standard` `obligatoire`<br/>**Ligne de commande** : <br/>•&nbsp;<a id="doc.change_default_value" name="doc.change_default_value">--doc.change_default_value</a><br/>•&nbsp;--doc.no-change_default_value<br/>**Variable d'environnement** : <a id="doc.change_default_value" name="doc.change_default_value">ROUGAILCLI_DOC.CHANGE_DEFAULT_VALUE</a> | Valeurs modifiées pour documenter les familles leader ou dynamique.<br/>**Défaut** : true |
| **<a id="doc.comment_examples" name="doc.comment_examples">doc.comment_examples</a>**<br/>`boolean` `standard` `obligatoire` *`désactivé`*<br/>**Ligne de commande** : <br/>•&nbsp;-dx, <a id="doc.comment_examples" name="doc.comment_examples">--doc.comment_examples</a><br/>•&nbsp;-ndx, --doc.no-comment_examples<br/>**Variable d'environnement** : <a id="doc.comment_examples" name="doc.comment_examples">ROUGAILCLI_DOC.COMMENT_EXAMPLES</a> | Ajouter la description des variables et des familles lorsqu&#x27;on génère des exemples.<br/>**Défaut** : false<br/>**Désactivé** : désactiver lorsqu'il example n'est pas dans contents |
| **<a id="doc.comment_examples_column" name="doc.comment_examples_column">doc.comment_examples_column</a>**<br/>`integer` `standard` `obligatoire` *`désactivé`*<br/>**Ligne de commande** : <a id="doc.comment_examples_column" name="doc.comment_examples_column">--doc.comment_examples_column</a><br/>**Variable d'environnement** : <a id="doc.comment_examples_column" name="doc.comment_examples_column">ROUGAILCLI_DOC.COMMENT_EXAMPLES_COLUMN</a> | Commentaire dans les exemples commence à la colonne.<br/>**Défaut** : 30<br/>**Désactivé** : lorsque la variable "[Ajouter la description des variables et des familles lorsqu&#x27;on génère des exemples](#doc.comment_examples)" est accessible et a la valeur "false" |
| **<a id="doc.output_format" name="doc.output_format">doc.output_format</a>**<br/>`choice` `standard` `obligatoire`<br/>**Ligne de commande** : -do, <a id="doc.output_format" name="doc.output_format">--doc.output_format</a><br/>**Variable d'environnement** : <a id="doc.output_format" name="doc.output_format">ROUGAILCLI_DOC.OUTPUT_FORMAT</a> | Générer le document au format.<br/>**Validateur** : le format de sortie json n'est pas compatible avec "changelog" et example" de la variable contents<br/>**Choix** : <br/>•&nbsp;console **← (défaut)**<br/>•&nbsp;asciidoc<br/>•&nbsp;html<br/>•&nbsp;github<br/>•&nbsp;gitlab<br/>•&nbsp;json |
| **<a id="doc.table_model" name="doc.table_model">doc.table_model</a>**<br/>`choice` `standard` `obligatoire`<br/>**Ligne de commande** : -dm, <a id="doc.table_model" name="doc.table_model">--doc.table_model</a><br/>**Variable d'environnement** : <a id="doc.table_model" name="doc.table_model">ROUGAILCLI_DOC.TABLE_MODEL</a> | Generate document inside table model.<br/>**Validateur** : le format de sortie json n'est pas compatible avec "changelog" et example" de la variable contents<br/>**Choix** : <br/>•&nbsp;two_columns **← (défaut)**<br/>•&nbsp;three_columns<br/>•&nbsp;four_columns<br/>•&nbsp;five_columns |
| **<a id="doc.force_true_color_terminal" name="doc.force_true_color_terminal">doc.force_true_color_terminal</a>**<br/>`boolean` `standard` `obligatoire`<br/>**Ligne de commande** : <br/>•&nbsp;<a id="doc.force_true_color_terminal" name="doc.force_true_color_terminal">--doc.force_true_color_terminal</a><br/>•&nbsp;--doc.no-force_true_color_terminal<br/>**Variable d'environnement** : <a id="doc.force_true_color_terminal" name="doc.force_true_color_terminal">ROUGAILCLI_DOC.FORCE_TRUE_COLOR_TERMINAL</a> | Force les vrais couleurs dans le terminal.<br/>**Défaut** : false |
# Générer la documentation
> **🛈 Informations**
>
> **<a id="doc" name="doc">doc</a>**\
> `basic` *`désactivé`*\
> **Désactivé** : lorsque "[Générer la documentation](#doc)" n'est pas spécifié dans "[Sélection pour sortie](#step.output)"
| Variable | Description | Default value |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------|
| **<a id="doc.title_level" name="doc.title_level">doc.title_level</a>**<br/>`integer` `standard` `obligatoire`<br/>**Ligne de commande** : -dt, <a id="doc.title_level" name="doc.title_level">--doc.title_level</a><br/>**Variable d'environnement** : <a id="doc.title_level" name="doc.title_level">ROUGAILCLI_DOC.TITLE_LEVEL</a> | Niveau de titre de départ. | 1 |
| **<a id="doc.contents" name="doc.contents">doc.contents</a>**<br/>`choice` `multiple` `standard` `obligatoire` `unique`<br/>**Ligne de commande** : -dc, <a id="doc.contents" name="doc.contents">--doc.contents</a><br/>**Variable d'environnement** : <a id="doc.contents" name="doc.contents">ROUGAILCLI_DOC.CONTENTS</a> | Contenu générer.<br/>**Choix** : <br/>•&nbsp;variables<br/>•&nbsp;example<br/>•&nbsp;changelog | <br/>•&nbsp;variables |
| **<a id="doc.previous_json_file" name="doc.previous_json_file">doc.previous_json_file</a>**<br/>`string` `basic` `obligatoire` *`désactivé`*<br/>**Ligne de commande** : -dp, <a id="doc.previous_json_file" name="doc.previous_json_file">--doc.previous_json_file</a><br/>**Variable d'environnement** : <a id="doc.previous_json_file" name="doc.previous_json_file">ROUGAILCLI_DOC.PREVIOUS_JSON_FILE</a> | Précédent fichier de description au format JSON.<br/>**Désactivé** : changelog n'est pas sélectionné dans "[Contenu générer](#doc.contents)" | |
| **<a id="doc.without_family" name="doc.without_family">doc.without_family</a>**<br/>`boolean` `standard` `obligatoire` *`désactivé`*<br/>**Ligne de commande** : <br/>•&nbsp;-df, <a id="doc.without_family" name="doc.without_family">--doc.without_family</a><br/>•&nbsp;-ndf, --doc.no-without_family<br/>**Variable d'environnement** : <a id="doc.without_family" name="doc.without_family">ROUGAILCLI_DOC.WITHOUT_FAMILY</a> | Ne pas ajouter les familles dans la documentation.<br/>**Désactivé** : if "[Générer le document au format](#doc.output_format)" is json or "[Contenu générer](#doc.contents)" hasn't variable or changelog | false |
| **<a id="doc.root" name="doc.root">doc.root</a>**<br/>`string` `standard`<br/>**Ligne de commande** : -dr, <a id="doc.root" name="doc.root">--doc.root</a><br/>**Variable d'environnement** : <a id="doc.root" name="doc.root">ROUGAILCLI_DOC.ROOT</a> | Documente les variables depuis cette famille. | |
| **<a id="doc.with_commandline" name="doc.with_commandline">doc.with_commandline</a>**<br/>`boolean` `standard` `obligatoire` *`désactivé`*<br/>**Ligne de commande** : <br/>•&nbsp;-dw, <a id="doc.with_commandline" name="doc.with_commandline">--doc.with_commandline</a><br/>•&nbsp;-ndw, --doc.no-with_commandline<br/>**Variable d'environnement** : <a id="doc.with_commandline" name="doc.with_commandline">ROUGAILCLI_DOC.WITH_COMMANDLINE</a> | Ajoute les informations de la ligne de commande dans la documentation.<br/>**Désactivé** : if "[Générer le document au format](#doc.output_format)" is json or "[Contenu générer](#doc.contents)" hasn't variable or changelog | false |
| **<a id="doc.with_environment" name="doc.with_environment">doc.with_environment</a>**<br/>`boolean` `standard` `obligatoire` *`désactivé`*<br/>**Ligne de commande** : <br/>•&nbsp;-de, <a id="doc.with_environment" name="doc.with_environment">--doc.with_environment</a><br/>•&nbsp;-nde, --doc.no-with_environment<br/>**Variable d'environnement** : <a id="doc.with_environment" name="doc.with_environment">ROUGAILCLI_DOC.WITH_ENVIRONMENT</a> | Ajoute les informations de variable d&#x27;environnement dans la documentation.<br/>**Désactivé** : if "[Générer le document au format](#doc.output_format)" is json or "[Contenu générer](#doc.contents)" hasn't variable or changelog | false |
| **<a id="doc.environment_default_environment_name" name="doc.environment_default_environment_name">doc.environment_default_environment_name</a>**<br/>`string` `standard` `obligatoire` *`désactivé`*<br/>**Ligne de commande** : -dd, <a id="doc.environment_default_environment_name" name="doc.environment_default_environment_name">--doc.environment_default_environment_name</a><br/>**Variable d'environnement** : <a id="doc.environment_default_environment_name" name="doc.environment_default_environment_name">ROUGAILCLI_DOC.ENVIRONMENT_DEFAULT_ENVIRONMENT_NAME</a> | Nom du préfixe d&#x27;environnement par défaut.<br/>**Validateur** : doit seulement utilise des caractères en majuscule<br/>**Désactivé** : si "__.main_namespace" n'est pas défini ou "[Ajoute les informations de variable d&#x27;environnement dans la documentation](#doc.with_environment)" est false | ROUGAIL |
# Les familles ou variables pour cette famille sont dans un autre fichier
> **🛈 Informations**
>
> **<a id="doc.other_root_filenames" name="doc.other_root_filenames">doc.other_root_filenames</a>**\
> Cette famille contient des listes de bloc de variable.\
> `basic` *`désactivé`*\
> **Désactivé** : documentation doit être séparée
| Variable | Description | Default value |
|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------|-----------------|
| **<a id="doc.other_root_filenames.root_path" name="doc.other_root_filenames.root_path">doc.other_root_filenames.root_path</a>**<br/>`string` `multiple` `standard` `unique`<br/>**Ligne de commande** : <a id="doc.other_root_filenames.root_path" name="doc.other_root_filenames.root_path">--doc.other_root_filenames.root_path</a><br/>**Variable d'environnement** : <a id="doc.other_root_filenames.root_path" name="doc.other_root_filenames.root_path">ROUGAILCLI_DOC.OTHER_ROOT_FILENAMES.ROOT_PATH</a> | Nom de la famille racine. | |
| **<a id="doc.other_root_filenames.filename" name="doc.other_root_filenames.filename">doc.other_root_filenames.filename</a>**<br/>`UNIX filename` `basic` `obligatoire`<br/>**Ligne de commande** : <a id="doc.other_root_filenames.filename" name="doc.other_root_filenames.filename">--doc.other_root_filenames.filename</a><br/>**Variable d'environnement** : <a id="doc.other_root_filenames.filename" name="doc.other_root_filenames.filename">ROUGAILCLI_DOC.OTHER_ROOT_FILENAMES.FILENAME</a> | Nom du fichier.<br/>**Validateurs** : <br/>•&nbsp;this filename could be a relative path<br/>•&nbsp;file type allowed: "fichier" et "répertoire" | |
| Variable | Description | Default value |
|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------|
| **<a id="doc.disabled_modes" name="doc.disabled_modes">doc.disabled_modes</a>**<br/>`string` `multiple` `standard` *`désactivé`* `unique`<br/>**Ligne de commande** : <a id="doc.disabled_modes" name="doc.disabled_modes">--doc.disabled_modes</a><br/>**Variable d'environnement** : <a id="doc.disabled_modes" name="doc.disabled_modes">ROUGAILCLI_DOC.DISABLED_MODES</a> | Désactiver la documentation des variables avec ces modes.<br/>**Validateur** : vérifier le mode existe déjà<br/>**Désactivé** : désactiver lorsqu'il n'y a pas de mode valable | |
| **<a id="doc.change_default_value" name="doc.change_default_value">doc.change_default_value</a>**<br/>`boolean` `standard` `obligatoire`<br/>**Ligne de commande** : <br/>•&nbsp;<a id="doc.change_default_value" name="doc.change_default_value">--doc.change_default_value</a><br/>•&nbsp;--doc.no-change_default_value<br/>**Variable d'environnement** : <a id="doc.change_default_value" name="doc.change_default_value">ROUGAILCLI_DOC.CHANGE_DEFAULT_VALUE</a> | Valeurs modifiées pour documenter les familles leader ou dynamique. | true |
| **<a id="doc.comment_examples" name="doc.comment_examples">doc.comment_examples</a>**<br/>`boolean` `standard` `obligatoire` *`désactivé`*<br/>**Ligne de commande** : <br/>•&nbsp;-dx, <a id="doc.comment_examples" name="doc.comment_examples">--doc.comment_examples</a><br/>•&nbsp;-ndx, --doc.no-comment_examples<br/>**Variable d'environnement** : <a id="doc.comment_examples" name="doc.comment_examples">ROUGAILCLI_DOC.COMMENT_EXAMPLES</a> | Ajouter la description des variables et des familles lorsqu&#x27;on génère des exemples.<br/>**Désactivé** : désactiver lorsqu'il example n'est pas dans contents | false |
| **<a id="doc.comment_examples_column" name="doc.comment_examples_column">doc.comment_examples_column</a>**<br/>`integer` `standard` `obligatoire` *`désactivé`*<br/>**Ligne de commande** : <a id="doc.comment_examples_column" name="doc.comment_examples_column">--doc.comment_examples_column</a><br/>**Variable d'environnement** : <a id="doc.comment_examples_column" name="doc.comment_examples_column">ROUGAILCLI_DOC.COMMENT_EXAMPLES_COLUMN</a> | Commentaire dans les exemples commence à la colonne.<br/>**Désactivé** : lorsque la variable "[Ajouter la description des variables et des familles lorsqu&#x27;on génère des exemples](#doc.comment_examples)" est accessible et a la valeur "false" | 30 |
| **<a id="doc.output_format" name="doc.output_format">doc.output_format</a>**<br/>`choice` `standard` `obligatoire`<br/>**Ligne de commande** : -do, <a id="doc.output_format" name="doc.output_format">--doc.output_format</a><br/>**Variable d'environnement** : <a id="doc.output_format" name="doc.output_format">ROUGAILCLI_DOC.OUTPUT_FORMAT</a> | Générer le document au format.<br/>**Validateur** : le format de sortie json n'est pas compatible avec "changelog" et example" de la variable contents<br/>**Choix** : <br/>•&nbsp;console<br/>•&nbsp;asciidoc<br/>•&nbsp;html<br/>•&nbsp;github<br/>•&nbsp;gitlab<br/>•&nbsp;json | console |
| **<a id="doc.table_model" name="doc.table_model">doc.table_model</a>**<br/>`choice` `standard` `obligatoire`<br/>**Ligne de commande** : -dm, <a id="doc.table_model" name="doc.table_model">--doc.table_model</a><br/>**Variable d'environnement** : <a id="doc.table_model" name="doc.table_model">ROUGAILCLI_DOC.TABLE_MODEL</a> | Generate document inside table model.<br/>**Validateur** : le format de sortie json n'est pas compatible avec "changelog" et example" de la variable contents<br/>**Choix** : <br/>•&nbsp;two_columns<br/>•&nbsp;three_columns<br/>•&nbsp;four_columns<br/>•&nbsp;five_columns | two_columns |
| **<a id="doc.force_true_color_terminal" name="doc.force_true_color_terminal">doc.force_true_color_terminal</a>**<br/>`boolean` `standard` `obligatoire`<br/>**Ligne de commande** : <br/>•&nbsp;<a id="doc.force_true_color_terminal" name="doc.force_true_color_terminal">--doc.force_true_color_terminal</a><br/>•&nbsp;--doc.no-force_true_color_terminal<br/>**Variable d'environnement** : <a id="doc.force_true_color_terminal" name="doc.force_true_color_terminal">ROUGAILCLI_DOC.FORCE_TRUE_COLOR_TERMINAL</a> | Force les vrais couleurs dans le terminal. | false |
# Générer la documentation
> **🛈 Informations**
>
> **<a id="doc" name="doc">doc</a>**\
> `basic` *`désactivé`*\
> **Désactivé** : lorsque "[Générer la documentation](#doc)" n'est pas spécifié dans "[Sélection pour sortie](#step.output)"
| Variable | Description | Default value | Type |
|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------|---------------------|
| **<a id="doc.title_level" name="doc.title_level">doc.title_level</a>**<br/>`standard` `obligatoire`<br/>**Ligne de commande** : -dt, <a id="doc.title_level" name="doc.title_level">--doc.title_level</a><br/>**Variable d'environnement** : <a id="doc.title_level" name="doc.title_level">ROUGAILCLI_DOC.TITLE_LEVEL</a> | Niveau de titre de départ. | 1 | `integer` |
| **<a id="doc.contents" name="doc.contents">doc.contents</a>**<br/>`standard` `obligatoire` `unique`<br/>**Ligne de commande** : -dc, <a id="doc.contents" name="doc.contents">--doc.contents</a><br/>**Variable d'environnement** : <a id="doc.contents" name="doc.contents">ROUGAILCLI_DOC.CONTENTS</a> | Contenu générer.<br/>**Choix** : <br/>•&nbsp;variables<br/>•&nbsp;example<br/>•&nbsp;changelog | <br/>•&nbsp;variables | `choice` `multiple` |
| **<a id="doc.previous_json_file" name="doc.previous_json_file">doc.previous_json_file</a>**<br/>`basic` `obligatoire` *`désactivé`*<br/>**Ligne de commande** : -dp, <a id="doc.previous_json_file" name="doc.previous_json_file">--doc.previous_json_file</a><br/>**Variable d'environnement** : <a id="doc.previous_json_file" name="doc.previous_json_file">ROUGAILCLI_DOC.PREVIOUS_JSON_FILE</a> | Précédent fichier de description au format JSON.<br/>**Désactivé** : changelog n'est pas sélectionné dans "[Contenu générer](#doc.contents)" | | `string` |
| **<a id="doc.without_family" name="doc.without_family">doc.without_family</a>**<br/>`standard` `obligatoire` *`désactivé`*<br/>**Ligne de commande** : <br/>•&nbsp;-df, <a id="doc.without_family" name="doc.without_family">--doc.without_family</a><br/>•&nbsp;-ndf, --doc.no-without_family<br/>**Variable d'environnement** : <a id="doc.without_family" name="doc.without_family">ROUGAILCLI_DOC.WITHOUT_FAMILY</a> | Ne pas ajouter les familles dans la documentation.<br/>**Désactivé** : if "[Générer le document au format](#doc.output_format)" is json or "[Contenu générer](#doc.contents)" hasn't variable or changelog | false | `boolean` |
| **<a id="doc.root" name="doc.root">doc.root</a>**<br/>`standard`<br/>**Ligne de commande** : -dr, <a id="doc.root" name="doc.root">--doc.root</a><br/>**Variable d'environnement** : <a id="doc.root" name="doc.root">ROUGAILCLI_DOC.ROOT</a> | Documente les variables depuis cette famille. | | `string` |
| **<a id="doc.with_commandline" name="doc.with_commandline">doc.with_commandline</a>**<br/>`standard` `obligatoire` *`désactivé`*<br/>**Ligne de commande** : <br/>•&nbsp;-dw, <a id="doc.with_commandline" name="doc.with_commandline">--doc.with_commandline</a><br/>•&nbsp;-ndw, --doc.no-with_commandline<br/>**Variable d'environnement** : <a id="doc.with_commandline" name="doc.with_commandline">ROUGAILCLI_DOC.WITH_COMMANDLINE</a> | Ajoute les informations de la ligne de commande dans la documentation.<br/>**Désactivé** : if "[Générer le document au format](#doc.output_format)" is json or "[Contenu générer](#doc.contents)" hasn't variable or changelog | false | `boolean` |
| **<a id="doc.with_environment" name="doc.with_environment">doc.with_environment</a>**<br/>`standard` `obligatoire` *`désactivé`*<br/>**Ligne de commande** : <br/>•&nbsp;-de, <a id="doc.with_environment" name="doc.with_environment">--doc.with_environment</a><br/>•&nbsp;-nde, --doc.no-with_environment<br/>**Variable d'environnement** : <a id="doc.with_environment" name="doc.with_environment">ROUGAILCLI_DOC.WITH_ENVIRONMENT</a> | Ajoute les informations de variable d&#x27;environnement dans la documentation.<br/>**Désactivé** : if "[Générer le document au format](#doc.output_format)" is json or "[Contenu générer](#doc.contents)" hasn't variable or changelog | false | `boolean` |
| **<a id="doc.environment_default_environment_name" name="doc.environment_default_environment_name">doc.environment_default_environment_name</a>**<br/>`standard` `obligatoire` *`désactivé`*<br/>**Ligne de commande** : -dd, <a id="doc.environment_default_environment_name" name="doc.environment_default_environment_name">--doc.environment_default_environment_name</a><br/>**Variable d'environnement** : <a id="doc.environment_default_environment_name" name="doc.environment_default_environment_name">ROUGAILCLI_DOC.ENVIRONMENT_DEFAULT_ENVIRONMENT_NAME</a> | Nom du préfixe d&#x27;environnement par défaut.<br/>**Validateur** : doit seulement utilise des caractères en majuscule<br/>**Désactivé** : si "__.main_namespace" n'est pas défini ou "[Ajoute les informations de variable d&#x27;environnement dans la documentation](#doc.with_environment)" est false | ROUGAIL | `string` |
# Les familles ou variables pour cette famille sont dans un autre fichier
> **🛈 Informations**
>
> **<a id="doc.other_root_filenames" name="doc.other_root_filenames">doc.other_root_filenames</a>**\
> Cette famille contient des listes de bloc de variable.\
> `basic` *`désactivé`*\
> **Désactivé** : documentation doit être séparée
| Variable | Description | Default value | Type |
|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------|-----------------|---------------------|
| **<a id="doc.other_root_filenames.root_path" name="doc.other_root_filenames.root_path">doc.other_root_filenames.root_path</a>**<br/>`standard` `unique`<br/>**Ligne de commande** : <a id="doc.other_root_filenames.root_path" name="doc.other_root_filenames.root_path">--doc.other_root_filenames.root_path</a><br/>**Variable d'environnement** : <a id="doc.other_root_filenames.root_path" name="doc.other_root_filenames.root_path">ROUGAILCLI_DOC.OTHER_ROOT_FILENAMES.ROOT_PATH</a> | Nom de la famille racine. | | `string` `multiple` |
| **<a id="doc.other_root_filenames.filename" name="doc.other_root_filenames.filename">doc.other_root_filenames.filename</a>**<br/>`basic` `obligatoire`<br/>**Ligne de commande** : <a id="doc.other_root_filenames.filename" name="doc.other_root_filenames.filename">--doc.other_root_filenames.filename</a><br/>**Variable d'environnement** : <a id="doc.other_root_filenames.filename" name="doc.other_root_filenames.filename">ROUGAILCLI_DOC.OTHER_ROOT_FILENAMES.FILENAME</a> | Nom du fichier.<br/>**Validateurs** : <br/>•&nbsp;this filename could be a relative path<br/>•&nbsp;file type allowed: "fichier" et "répertoire" | | `UNIX filename` |
| Variable | Description | Default value | Type |
|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------|---------------------|
| **<a id="doc.disabled_modes" name="doc.disabled_modes">doc.disabled_modes</a>**<br/>`standard` *`désactivé`* `unique`<br/>**Ligne de commande** : <a id="doc.disabled_modes" name="doc.disabled_modes">--doc.disabled_modes</a><br/>**Variable d'environnement** : <a id="doc.disabled_modes" name="doc.disabled_modes">ROUGAILCLI_DOC.DISABLED_MODES</a> | Désactiver la documentation des variables avec ces modes.<br/>**Validateur** : vérifier le mode existe déjà<br/>**Désactivé** : désactiver lorsqu'il n'y a pas de mode valable | | `string` `multiple` |
| **<a id="doc.change_default_value" name="doc.change_default_value">doc.change_default_value</a>**<br/>`standard` `obligatoire`<br/>**Ligne de commande** : <br/>•&nbsp;<a id="doc.change_default_value" name="doc.change_default_value">--doc.change_default_value</a><br/>•&nbsp;--doc.no-change_default_value<br/>**Variable d'environnement** : <a id="doc.change_default_value" name="doc.change_default_value">ROUGAILCLI_DOC.CHANGE_DEFAULT_VALUE</a> | Valeurs modifiées pour documenter les familles leader ou dynamique. | true | `boolean` |
| **<a id="doc.comment_examples" name="doc.comment_examples">doc.comment_examples</a>**<br/>`standard` `obligatoire` *`désactivé`*<br/>**Ligne de commande** : <br/>•&nbsp;-dx, <a id="doc.comment_examples" name="doc.comment_examples">--doc.comment_examples</a><br/>•&nbsp;-ndx, --doc.no-comment_examples<br/>**Variable d'environnement** : <a id="doc.comment_examples" name="doc.comment_examples">ROUGAILCLI_DOC.COMMENT_EXAMPLES</a> | Ajouter la description des variables et des familles lorsqu&#x27;on génère des exemples.<br/>**Désactivé** : désactiver lorsqu'il example n'est pas dans contents | false | `boolean` |
| **<a id="doc.comment_examples_column" name="doc.comment_examples_column">doc.comment_examples_column</a>**<br/>`standard` `obligatoire` *`désactivé`*<br/>**Ligne de commande** : <a id="doc.comment_examples_column" name="doc.comment_examples_column">--doc.comment_examples_column</a><br/>**Variable d'environnement** : <a id="doc.comment_examples_column" name="doc.comment_examples_column">ROUGAILCLI_DOC.COMMENT_EXAMPLES_COLUMN</a> | Commentaire dans les exemples commence à la colonne.<br/>**Désactivé** : lorsque la variable "[Ajouter la description des variables et des familles lorsqu&#x27;on génère des exemples](#doc.comment_examples)" est accessible et a la valeur "false" | 30 | `integer` |
| **<a id="doc.output_format" name="doc.output_format">doc.output_format</a>**<br/>`standard` `obligatoire`<br/>**Ligne de commande** : -do, <a id="doc.output_format" name="doc.output_format">--doc.output_format</a><br/>**Variable d'environnement** : <a id="doc.output_format" name="doc.output_format">ROUGAILCLI_DOC.OUTPUT_FORMAT</a> | Générer le document au format.<br/>**Validateur** : le format de sortie json n'est pas compatible avec "changelog" et example" de la variable contents<br/>**Choix** : <br/>•&nbsp;console<br/>•&nbsp;asciidoc<br/>•&nbsp;html<br/>•&nbsp;github<br/>•&nbsp;gitlab<br/>•&nbsp;json | console | `choice` |
| **<a id="doc.table_model" name="doc.table_model">doc.table_model</a>**<br/>`standard` `obligatoire`<br/>**Ligne de commande** : -dm, <a id="doc.table_model" name="doc.table_model">--doc.table_model</a><br/>**Variable d'environnement** : <a id="doc.table_model" name="doc.table_model">ROUGAILCLI_DOC.TABLE_MODEL</a> | Generate document inside table model.<br/>**Validateur** : le format de sortie json n'est pas compatible avec "changelog" et example" de la variable contents<br/>**Choix** : <br/>•&nbsp;two_columns<br/>•&nbsp;three_columns<br/>•&nbsp;four_columns<br/>•&nbsp;five_columns | two_columns | `choice` |
| **<a id="doc.force_true_color_terminal" name="doc.force_true_color_terminal">doc.force_true_color_terminal</a>**<br/>`standard` `obligatoire`<br/>**Ligne de commande** : <br/>•&nbsp;<a id="doc.force_true_color_terminal" name="doc.force_true_color_terminal">--doc.force_true_color_terminal</a><br/>•&nbsp;--doc.no-force_true_color_terminal<br/>**Variable d'environnement** : <a id="doc.force_true_color_terminal" name="doc.force_true_color_terminal">ROUGAILCLI_DOC.FORCE_TRUE_COLOR_TERMINAL</a> | Force les vrais couleurs dans le terminal. | false | `boolean` |
# Générer la documentation
> **🛈 Informations**
>
> **<a id="doc" name="doc">doc</a>**\
> `basic` *`désactivé`*\
> **Désactivé** : lorsque "[Générer la documentation](#doc)" n'est pas spécifié dans "[Sélection pour sortie](#step.output)"
| Variable | Description | Default value | Type |
|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------|-----------------------|---------------------|
| **<a id="doc.title_level" name="doc.title_level">doc.title_level</a>**<br/>`standard` `obligatoire`<br/>**Ligne de commande** : -dt, <a id="doc.title_level" name="doc.title_level">--doc.title_level</a><br/>**Variable d'environnement** : <a id="doc.title_level" name="doc.title_level">ROUGAILCLI_DOC.TITLE_LEVEL</a> | Niveau de titre de départ. | 1 | `integer` |
| **<a id="doc.contents" name="doc.contents">doc.contents</a>**<br/>`standard` `obligatoire` `unique`<br/>**Ligne de commande** : -dc, <a id="doc.contents" name="doc.contents">--doc.contents</a><br/>**Variable d'environnement** : <a id="doc.contents" name="doc.contents">ROUGAILCLI_DOC.CONTENTS</a> | Contenu générer.<br/>**Choix** : <br/>•&nbsp;variables<br/>•&nbsp;example<br/>•&nbsp;changelog | <br/>•&nbsp;variables | `choice` `multiple` |
| **<a id="doc.previous_json_file" name="doc.previous_json_file">doc.previous_json_file</a>**<br/>`basic` `obligatoire` *`désactivé`*<br/>**Ligne de commande** : -dp, <a id="doc.previous_json_file" name="doc.previous_json_file">--doc.previous_json_file</a><br/>**Variable d'environnement** : <a id="doc.previous_json_file" name="doc.previous_json_file">ROUGAILCLI_DOC.PREVIOUS_JSON_FILE</a> | Précédent fichier de description au format JSON. | | `string` |
| **<a id="doc.without_family" name="doc.without_family">doc.without_family</a>**<br/>`standard` `obligatoire` *`désactivé`*<br/>**Ligne de commande** : <br/>•&nbsp;-df, <a id="doc.without_family" name="doc.without_family">--doc.without_family</a><br/>•&nbsp;-ndf, --doc.no-without_family<br/>**Variable d'environnement** : <a id="doc.without_family" name="doc.without_family">ROUGAILCLI_DOC.WITHOUT_FAMILY</a> | Ne pas ajouter les familles dans la documentation. | false | `boolean` |
| **<a id="doc.root" name="doc.root">doc.root</a>**<br/>`standard`<br/>**Ligne de commande** : -dr, <a id="doc.root" name="doc.root">--doc.root</a><br/>**Variable d'environnement** : <a id="doc.root" name="doc.root">ROUGAILCLI_DOC.ROOT</a> | Documente les variables depuis cette famille. | | `string` |
| **<a id="doc.with_commandline" name="doc.with_commandline">doc.with_commandline</a>**<br/>`standard` `obligatoire` *`désactivé`*<br/>**Ligne de commande** : <br/>•&nbsp;-dw, <a id="doc.with_commandline" name="doc.with_commandline">--doc.with_commandline</a><br/>•&nbsp;-ndw, --doc.no-with_commandline<br/>**Variable d'environnement** : <a id="doc.with_commandline" name="doc.with_commandline">ROUGAILCLI_DOC.WITH_COMMANDLINE</a> | Ajoute les informations de la ligne de commande dans la documentation. | false | `boolean` |
| **<a id="doc.with_environment" name="doc.with_environment">doc.with_environment</a>**<br/>`standard` `obligatoire` *`désactivé`*<br/>**Ligne de commande** : <br/>•&nbsp;-de, <a id="doc.with_environment" name="doc.with_environment">--doc.with_environment</a><br/>•&nbsp;-nde, --doc.no-with_environment<br/>**Variable d'environnement** : <a id="doc.with_environment" name="doc.with_environment">ROUGAILCLI_DOC.WITH_ENVIRONMENT</a> | Ajoute les informations de variable d&#x27;environnement dans la documentation. | false | `boolean` |
| **<a id="doc.environment_default_environment_name" name="doc.environment_default_environment_name">doc.environment_default_environment_name</a>**<br/>`standard` `obligatoire` *`désactivé`*<br/>**Ligne de commande** : -dd, <a id="doc.environment_default_environment_name" name="doc.environment_default_environment_name">--doc.environment_default_environment_name</a><br/>**Variable d'environnement** : <a id="doc.environment_default_environment_name" name="doc.environment_default_environment_name">ROUGAILCLI_DOC.ENVIRONMENT_DEFAULT_ENVIRONMENT_NAME</a> | Nom du préfixe d&#x27;environnement par défaut.<br/>**Validateur** : doit seulement utilise des caractères en majuscule | ROUGAIL | `string` |
# Les familles ou variables pour cette famille sont dans un autre fichier
> **🛈 Informations**
>
> **<a id="doc.other_root_filenames" name="doc.other_root_filenames">doc.other_root_filenames</a>**\
> Cette famille contient des listes de bloc de variable.\
> `basic` *`désactivé`*\
> **Désactivé** : documentation doit être séparée
| Variable | Description | Default value | Type |
|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------|-----------------|---------------------|
| **<a id="doc.other_root_filenames.root_path" name="doc.other_root_filenames.root_path">doc.other_root_filenames.root_path</a>**<br/>`standard` `unique`<br/>**Ligne de commande** : <a id="doc.other_root_filenames.root_path" name="doc.other_root_filenames.root_path">--doc.other_root_filenames.root_path</a><br/>**Variable d'environnement** : <a id="doc.other_root_filenames.root_path" name="doc.other_root_filenames.root_path">ROUGAILCLI_DOC.OTHER_ROOT_FILENAMES.ROOT_PATH</a> | Nom de la famille racine. | | `string` `multiple` |
| **<a id="doc.other_root_filenames.filename" name="doc.other_root_filenames.filename">doc.other_root_filenames.filename</a>**<br/>`basic` `obligatoire`<br/>**Ligne de commande** : <a id="doc.other_root_filenames.filename" name="doc.other_root_filenames.filename">--doc.other_root_filenames.filename</a><br/>**Variable d'environnement** : <a id="doc.other_root_filenames.filename" name="doc.other_root_filenames.filename">ROUGAILCLI_DOC.OTHER_ROOT_FILENAMES.FILENAME</a> | Nom du fichier.<br/>**Validateurs** : <br/>•&nbsp;this filename could be a relative path<br/>•&nbsp;file type allowed: "fichier" et "répertoire" | | `UNIX filename` |
| Variable | Description | Default value | Type |
|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------|---------------------|
| **<a id="doc.disabled_modes" name="doc.disabled_modes">doc.disabled_modes</a>**<br/>`standard` *`désactivé`* `unique`<br/>**Ligne de commande** : <a id="doc.disabled_modes" name="doc.disabled_modes">--doc.disabled_modes</a><br/>**Variable d'environnement** : <a id="doc.disabled_modes" name="doc.disabled_modes">ROUGAILCLI_DOC.DISABLED_MODES</a> | Désactiver la documentation des variables avec ces modes.<br/>**Validateur** : vérifier le mode existe déjà | | `string` `multiple` |
| **<a id="doc.change_default_value" name="doc.change_default_value">doc.change_default_value</a>**<br/>`standard` `obligatoire`<br/>**Ligne de commande** : <br/>•&nbsp;<a id="doc.change_default_value" name="doc.change_default_value">--doc.change_default_value</a><br/>•&nbsp;--doc.no-change_default_value<br/>**Variable d'environnement** : <a id="doc.change_default_value" name="doc.change_default_value">ROUGAILCLI_DOC.CHANGE_DEFAULT_VALUE</a> | Valeurs modifiées pour documenter les familles leader ou dynamique. | true | `boolean` |
| **<a id="doc.comment_examples" name="doc.comment_examples">doc.comment_examples</a>**<br/>`standard` `obligatoire` *`désactivé`*<br/>**Ligne de commande** : <br/>•&nbsp;-dx, <a id="doc.comment_examples" name="doc.comment_examples">--doc.comment_examples</a><br/>•&nbsp;-ndx, --doc.no-comment_examples<br/>**Variable d'environnement** : <a id="doc.comment_examples" name="doc.comment_examples">ROUGAILCLI_DOC.COMMENT_EXAMPLES</a> | Ajouter la description des variables et des familles lorsqu&#x27;on génère des exemples. | false | `boolean` |
| **<a id="doc.comment_examples_column" name="doc.comment_examples_column">doc.comment_examples_column</a>**<br/>`standard` `obligatoire` *`désactivé`*<br/>**Ligne de commande** : <a id="doc.comment_examples_column" name="doc.comment_examples_column">--doc.comment_examples_column</a><br/>**Variable d'environnement** : <a id="doc.comment_examples_column" name="doc.comment_examples_column">ROUGAILCLI_DOC.COMMENT_EXAMPLES_COLUMN</a> | Commentaire dans les exemples commence à la colonne. | 30 | `integer` |
| **<a id="doc.output_format" name="doc.output_format">doc.output_format</a>**<br/>`standard` `obligatoire`<br/>**Ligne de commande** : -do, <a id="doc.output_format" name="doc.output_format">--doc.output_format</a><br/>**Variable d'environnement** : <a id="doc.output_format" name="doc.output_format">ROUGAILCLI_DOC.OUTPUT_FORMAT</a> | Générer le document au format.<br/>**Validateur** : le format de sortie json n'est pas compatible avec "changelog" et example" de la variable contents<br/>**Choix** : <br/>•&nbsp;console<br/>•&nbsp;asciidoc<br/>•&nbsp;html<br/>•&nbsp;github<br/>•&nbsp;gitlab<br/>•&nbsp;json | console | `choice` |
| **<a id="doc.table_model" name="doc.table_model">doc.table_model</a>**<br/>`standard` `obligatoire`<br/>**Ligne de commande** : -dm, <a id="doc.table_model" name="doc.table_model">--doc.table_model</a><br/>**Variable d'environnement** : <a id="doc.table_model" name="doc.table_model">ROUGAILCLI_DOC.TABLE_MODEL</a> | Generate document inside table model.<br/>**Validateur** : le format de sortie json n'est pas compatible avec "changelog" et example" de la variable contents<br/>**Choix** : <br/>•&nbsp;two_columns<br/>•&nbsp;three_columns<br/>•&nbsp;four_columns<br/>•&nbsp;five_columns | two_columns | `choice` |
| **<a id="doc.force_true_color_terminal" name="doc.force_true_color_terminal">doc.force_true_color_terminal</a>**<br/>`standard` `obligatoire`<br/>**Ligne de commande** : <br/>•&nbsp;<a id="doc.force_true_color_terminal" name="doc.force_true_color_terminal">--doc.force_true_color_terminal</a><br/>•&nbsp;--doc.no-force_true_color_terminal<br/>**Variable d'environnement** : <a id="doc.force_true_color_terminal" name="doc.force_true_color_terminal">ROUGAILCLI_DOC.FORCE_TRUE_COLOR_TERMINAL</a> | Force les vrais couleurs dans le terminal. | false | `boolean` |
feat: document commandline and environment variable
2025-11-27 22:17:17 +01:00
Initial commit
2024-07-10 21:23:57 +02:00
Reference in a new issue Copy permalink