Skip to content

ci: fix and prevent Markdown lint errors in translations #2752

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dunglas merged 2 commits into from
Oct 23, 2026
Merged

ci: fix and prevent Markdown lint errors in translations #2752

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
768c415
docs: fix invalid anchors and blockquote in translations
dunglas Oct 23, 2026
ce9ea68
ci: prevent invalid Markdown in generated translations
dunglas Oct 23, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions .github/workflows/translate.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,13 +44,12 @@ jobs:
php ./docs/translate.php "$MD_FILES"
- name: Run Linter
if: steps.md_files.outputs.found == 'true'
continue-on-error: true
uses: super-linter/super-linter/slim@2da136927bd4a73596db63044b504547c62cb854 # v9.0.0
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
LINTER_RULES_PATH: /
MARKDOWN_CONFIG_FILE: .markdown-lint.yaml
VALIDATE_NATURAL_LANGUAGE: false
VALIDATE_MARKDOWN: true
FIX_MARKDOWN: true
- name: Create Pull Request
if: steps.md_files.outputs.found == 'true'
Expand Down
2 changes: 1 addition & 1 deletion docs/cn/static.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ docker run --rm -v "$PWD/output:/output" -e OUTPUT_DIR=/output -e SPC_LOGS_DIR=/
> 如果 `XCADDY_ARGS` 为空或未设置，则默认包含 cbrotli、Mercure 和 Vulcain 模块。
> 如果您自定义 `XCADDY_ARGS` 的值，则必须显式包含它们才能使其生效。

另请参阅如何 [自定义 FrankenPHP 静态构建](#customizing-the-frankenphp-static-build)
另请参阅如何 [自定义 FrankenPHP 静态构建](#自定义-frankenphp-静态构建)

### GitHub token

Expand Down
2 changes: 1 addition & 1 deletion docs/fr/hot-reload.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Selon votre configuration, le navigateur va soit :
Pour activer le hot reload, activez Mercure, puis ajoutez la sous-directive `hot_reload` à la directive `php_server` dans votre `Caddyfile`.

> [!WARNING]

>
> Cette fonctionnalité est destinée **uniquement aux environnements de développement**.
> N'activez pas `hot_reload` en production, car cette fonctionnalité n'est pas sécurisée (expose des détails internes sensibles) et ralentit l'application.

Expand Down
2 changes: 1 addition & 1 deletion docs/fr/static.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ Dans cet exemple, nous ajoutons le module de cache HTTP [Souin](https://souin.io
> Les modules cbrotli, Mercure et Vulcain sont inclus par défaut si `XCADDY_ARGS` est vide ou n'est pas défini.
> Si vous personnalisez la valeur de `XCADDY_ARGS`, vous devez les inclure explicitement si vous voulez qu'ils soient inclus.

Voir aussi comment [personnaliser la construction statique de FrankenPHP](#customizing-the-frankenphp-static-build)
Voir aussi comment [personnaliser la construction statique de FrankenPHP](#personnalisation-de-la-construction-statique-de-frankenphp)

### Jeton GitHub

Expand Down
2 changes: 1 addition & 1 deletion docs/it/static.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ In questo esempio, aggiungiamo il modulo cache HTTP [Souin](https://souin.io) pe
> I moduli cbrotli, Mercure e Vulcain sono inclusi per impostazione predefinita se `XCADDY_ARGS` è vuoto o non impostato.
> Se personalizzi il valore di `XCADDY_ARGS`, devi includerli esplicitamente se desideri che siano inclusi.

Scopri anche come [personalizzare la build statica di FrankenPHP](#customizing-the-frankenphp-static-build)
Scopri anche come [personalizzare la build statica di FrankenPHP](#personalizzare-la-build-statica-di-frankenphp)

### Token GitHub

Expand Down
1 change: 1 addition & 0 deletions docs/translate.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@
* **General Links:** You must not translate link URLs, only the link text.
* **php.net Exception:** You must rewrite all `php.net` URLs to use their language-agnostic format by removing the language segment (e.g., change `https://www.php.net/manual/en/function.echo.php` to `https://www.php.net/manual/function.echo.php`).
* **Anchors:** You may translate anchors to translation pages (e.g., `config.md#translated-anchor`), but keep existing anchors as they are.
* **Same-page Anchors:** Headings are translated, so every link to a heading of the same document (e.g., `#customizing-the-frankenphp-static-build`) must use the anchor GitHub generates from the translated heading (lowercase, spaces replaced by hyphens, punctuation removed).
* **Content Integrity:** You must not add or remove any content; only translate what is present.
* **Accuracy:** You must ensure that the translation is accurate and faithful to the original meaning.
* **Style:** You must write in a natural and fluent style appropriate for technical documentation.
Expand Down
Loading