You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/en/docs/contributing.md
+19-19Lines changed: 19 additions & 19 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -372,25 +372,6 @@ You can continue with the previous instructions for an "Existing Language" for t
372
372
373
373
You can make the first pull request with those two files, `docs/ht/mkdocs.yml` and `docs/ht/index.md`. 🎉
374
374
375
-
#### Tips and tricks for translation
376
-
377
-
* Translate only the Markdown documents (`.md`). Do not translate the code examples at `./docs_src`.
378
-
379
-
* In code blocks within the Markdown document, translate comments (`# a comment`), but leave the rest unchanged.
380
-
381
-
* Do not change anything enclosed in "``" (inline code).
382
-
383
-
* In lines starting with `===` or `!!!`, translate only the ` "... Text ..."` part. Leave the rest unchanged.
384
-
385
-
* You can translate info boxes like `!!! warning` with for example `!!! warning "Achtung"`. But do not change the word immediately after the `!!!`, it determines the color of the info box.
386
-
387
-
* Do not change the paths in links to images, code files, Markdown documents.
388
-
389
-
* However, when a Markdown document is translated, the `#hash-parts` in links to its headings may change. Update these links if possible.
390
-
* Search for such links in the translated document using the regex `#[^# ]`.
391
-
* Search in all documents already translated into your language for `your-translated-document.md`. For example VS Code has an option "Edit" -> "Find in Files".
392
-
* When translating a document, do not "pre-translate" `#hash-parts` that link to headings in untranslated documents.
393
-
394
375
#### Preview the result
395
376
396
377
As already mentioned above, You can use the `./scripts/docs.py` with the `live` command to preview the results (or `mkdocs serve`).
* Translate only the Markdown documents (`.md`). Do not translate the code examples at `./docs_src`.
417
+
418
+
* In code blocks within the Markdown document, translate comments (`# a comment`), but leave the rest unchanged.
419
+
420
+
* Do not change anything enclosed in "``" (inline code).
421
+
422
+
* In lines starting with `===` or `!!!`, translate only the ` "... Text ..."` part. Leave the rest unchanged.
423
+
424
+
* You can translate info boxes like `!!! warning` with for example `!!! warning "Achtung"`. But do not change the word immediately after the `!!!`, it determines the color of the info box.
425
+
426
+
* Do not change the paths in links to images, code files, Markdown documents.
427
+
428
+
* However, when a Markdown document is translated, the `#hash-parts` in links to its headings may change. Update these links if possible.
429
+
* Search for such links in the translated document using the regex `#[^# ]`.
430
+
* Search in all documents already translated into your language for `your-translated-document.md`. For example VS Code has an option "Edit" -> "Find in Files".
431
+
* When translating a document, do not "pre-translate" `#hash-parts` that link to headings in untranslated documents.
432
+
433
433
## Tests
434
434
435
435
There is a script that you can run locally to test all the code and generate coverage reports in HTML:
0 commit comments