Skip to content

Commit 3d5e30b

Browse files
committed
docs: update note formatting in EXAMPLES.md to use [!NOTE] syntax
1 parent b80e22a commit 3d5e30b

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

docs/EXAMPLES.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -131,7 +131,7 @@ jobs:
131131
132132
The Action/CLI will automatically detect the [environment variables](https://crowdin.github.io/crowdin-cli/configuration#environment-variables) and use them for the configuration.
133133
134-
> **Note**
134+
> [!NOTE]
135135
> To avoid any conflicts, do not use the `crowdin.yml` file in the repository when using the above configuration approach.
136136

137137
### Upload sources only
@@ -195,7 +195,7 @@ Note that the value of the `crowdin_branch_name` is `env.BRANCH_NAME` - this is
195195

196196
The Crowdin CLI supports a `--cache` parameter for the `upload sources` command that stores source file checksums locally. This allows the CLI to only upload files that have changed, significantly reducing upload time for large projects.
197197

198-
> **Note**
198+
> [!NOTE]
199199
> The cache feature is experimental. For any feedback, visit [Crowdin CLI Discussions](https://github.com/crowdin/crowdin-cli/discussions).
200200

201201
To persist the cache between workflow runs, use the `actions/cache` action to save and restore the cache file located at `~/.crowdin/cache.json`:
@@ -302,7 +302,7 @@ jobs:
302302
CROWDIN_PERSONAL_TOKEN: ${{ secrets.CROWDIN_PERSONAL_TOKEN }}
303303
```
304304

305-
> **Note**
305+
> [!NOTE]
306306
> If you are using a **String-based** project, you need to use this option to download translations. The default `download_translations` option does not work for this type of projects.
307307

308308
The `download_bundle` option accepts the bundle numeric ID.
@@ -601,7 +601,7 @@ To set this up:
601601

602602
For more details, see [GitHub issue #270](https://github.com/crowdin/github-action/issues/270).
603603

604-
> **Note**
604+
> [!NOTE]
605605
> When using a GitHub App token via `GH_TOKEN`, the Checkout step must use `persist-credentials: false`. Otherwise, the default `GITHUB_TOKEN` cached in `.git/config` by `actions/checkout` takes precedence over `GH_TOKEN`, and the action will not use your App token for creating pull requests.
606606

607607
### Checking the translation progress

0 commit comments

Comments
 (0)