LukeParke/redocly-cli
1
0
Fork 0
mirror of https://github.com/LukeHagar/redocly-cli.git synced 2025-12-06 04:21:09 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: updating translate doc with project-dir option (#1714)

Browse Source
This commit is contained in:
Taylor Krusen
2024-09-06 18:27:58 -07:00
committed by GitHub
parent 11f5713cef
commit d555aea697
1 changed files with 40 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

46
docs/commands/translate.md
View File

@@ -19,12 +19,13 @@ redocly translate --version
## Options
| Option | Type | Description |
| --------------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------- |
| `locale` | string | **REQUIRED** Name of a locale folder, inside your project's `l10n` directory, to generate translations for. Use `all` for all locales. |
| `--lint-config` | string | Severity level for config file linting. Possible values: `warn`, `error`, `off`. Defaults to `warn`. |
| `--help` | boolean | Show help. |
| `--version` | boolean | Show version number. |
| Option | Type | Description |
| ----------------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------- |
| `locale` | string | **REQUIRED** Name of a locale folder, inside your project's `l10n` directory, to generate translations for. Use `all` for all locales. |
| `--lint-config` | string | Severity level for config file linting. Possible values: `warn`, `error`, `off`. Defaults to `warn`. |
| --project-dir, -d | string | Path to the project directory. The default value is `.` (current directory). |
| `--help` | boolean | Show help. |
| `--version` | boolean | Show version number. |
## Examples
@@ -69,6 +70,39 @@ your-awesome-project
└── ...
```
### Populate translation keys in a specific project
Use the `--project-dir` option to run the `translate` command from a parent folder and populate translation keys inside a specific project:
```bash
redocly translate all --project-dir='museum-docs'
```
The following project structure represents the output of running this command from the `projects` folder:
```treeview {% title="Multiple projects in same folder" %}
projects/
├── storage-docs/
├── authentication-docs/
└── museum-docs/
├── @l10n/
│ ├── es-ES/
│ │ ├── transcriptions.yaml
│ │ └── ...
│ ├── fr/
│ │ ├── transcriptions.yaml
│ │ └── ...
│ └── nl-NL/
│ ├── transcriptions.yaml
│ └── ...
├── index.md
├── sidebars.md
├── redocly.yaml
└── ...
```
The `--project-dir` option is designed to help manage multiple projects by reducing the need for traversal.
## Tips for using `translate`
- The command is additive; it doesn't overwrite existing translation keys.