You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

60 lines
3.1 KiB

  1. # QMK ドキュメントを翻訳する
  2. <!---
  3. original document: 0.9.51:docs/translating.md
  4. git diff 0.9.51 HEAD -- docs/translating.md | cat
  5. -->
  6. ルートフォルダ (`docs/`) にある全てのファイルは英語でなければなりません - 他の全ての言語は、ISO 639-1 言語コードと、それに続く`-`と関連する国コードのサブフォルダにある必要があります。[一般的なもののリストはここで見つかります](https://www.andiamo.co.uk/resources/iso-language-codes/)。このフォルダが存在しない場合、作成することができます。翻訳された各ファイルは英語バージョンと同じ名前でなければなりません。そうすることで、正常にフォールバックできます。
  7. `_summary.md` ファイルはこのフォルダの中に存在し、各ファイルへのリンクのリスト、翻訳された名前、言語フォルダに続くリンクが含まれている必要があります。
  8. ```markdown
  9. * [QMK简介](zh-cn/getting_started_introduction.md)
  10. ```
  11. 他の docs ページへの全てのリンクにも、言語のフォルダが前に付いている必要があります。もしリンクがページの特定の部分(例えば、特定の見出し)への場合、以下のように見出しに英語の ID を使う必要があります:
  12. ```markdown
  13. [建立你的环境](zh-cn/newbs-getting-started.md#set-up-your-environment)
  14. ## 建立你的环境 :id=set-up-your-environment
  15. ```
  16. 新しい言語の翻訳が完了したら、以下のファイルも修正する必要があります:
  17. * [`docs/_langs.md`](https://github.com/qmk/qmk_firmware/blob/master/docs/_langs.md)
  18. 各行は、[GitHub emoji shortcode](https://github.com/ikatyang/emoji-cheat-sheet/blob/master/README.md#country-flag) の形式で国フラグと、それに続く言語で表される名前を含む必要があります。
  19. ```markdown
  20. - [:cn: 中文](/zh-cn/)
  21. ```
  22. * [`docs/index.html`](https://github.com/qmk/qmk_firmware/blob/master/docs/index.html)
  23. `placeholder``noData` の両方のオブジェクトは、文字列で言語フォルダの辞書エントリが必要です:
  24. ```js
  25. '/zh-cn/': '没有结果!',
  26. ```
  27. サイドバーの「QMK ファームウェア」の見出しリンクを設定するために、`nameLink` オブジェクトも以下のように追加される必要があります:
  28. ```js
  29. '/zh-cn/': '/#/zh-cn/',
  30. ```
  31. また、`fallbackLanguages` リストに言語フォルダを追加して、404 ではなく英語に適切にフォールバックするようにしてください:
  32. ```js
  33. fallbackLanguages: [
  34. // ...
  35. 'zh-cn',
  36. // ...
  37. ],
  38. ```
  39. ## 翻訳のプレビュー
  40. ドキュメントのローカルインスタンスをセットアップする方法については、[ドキュメントのプレビュー](ja/contributing.md#previewing-the-documentation)を見てください - 右上の "Translations" メニューから新しい言語を選択することができるはずです。
  41. 作業に満足したら、遠慮なくプルリクエストを開いてください!