From 950042bf1562b37420319e1435feeaf9d76a8315 Mon Sep 17 00:00:00 2001 From: Andrii Bodnar Date: Thu, 7 Sep 2023 10:48:57 +0300 Subject: [PATCH] docs: separate section for the 'crowdin download translations' subcommand (#633) --- .../crowdin-download-translations.adoc | 35 +++++++++++++++++++ website/sidebars.js | 1 + 2 files changed, 36 insertions(+) create mode 100644 website/mantemplates/crowdin-download-translations.adoc diff --git a/website/mantemplates/crowdin-download-translations.adoc b/website/mantemplates/crowdin-download-translations.adoc new file mode 100644 index 000000000..edf1cd095 --- /dev/null +++ b/website/mantemplates/crowdin-download-translations.adoc @@ -0,0 +1,35 @@ +:includedir: ../generated-picocli-docs +:command: crowdin-download + +== crowdin download translations + +include::{includedir}/{command}.adoc[tag=picocli-generated-man-section-description] + +include::{includedir}/{command}.adoc[tag=picocli-generated-man-section-synopsis] + +include::{includedir}/{command}.adoc[tag=picocli-generated-man-section-arguments] + +include::{includedir}/{command}.adoc[tag=picocli-generated-man-section-commands] + +include::{includedir}/{command}.adoc[tag=picocli-generated-man-section-options] + +include::{includedir}/{command}.adoc[tag=picocli-generated-man-section-footer] + +=== Notes + +- `-l`, `--language=language_code` - defines the language translations that should be downloaded from Crowdin. By default, translations are downloaded for all project's target languages. link:https://developer.crowdin.com/language-codes/[Crowdin Language Codes]. + +=== Examples + +Download multiple languages: + +---- +crowdin download -l de -l fr -l it +crowdin download --language=de --language=fr --language=it +---- + +Download all translations even if the corresponding source files are missing locally: + +---- +crowdin download --all +---- diff --git a/website/sidebars.js b/website/sidebars.js index e0bc9b251..8d14a150c 100644 --- a/website/sidebars.js +++ b/website/sidebars.js @@ -50,6 +50,7 @@ const sidebars = { collapsible: true, collapsed: true, items: [ + 'commands/crowdin-download-translations', 'commands/crowdin-download-sources', 'commands/crowdin-download-bundle', ]