Merge pull request #28524 from t-inu/issue28456

[ja] Add precautions about Markdown notation
2021-06-20 22:56:51 -07:00
parent bcf87d50dd 42283c1d6a
commit 3e882a206d
1 changed files with 10 additions and 1 deletions
@@ -40,7 +40,7 @@ card:

 ### Pull Requestを送るまで

-未翻訳ページの新規翻訳作業と既存ページの修正作業でそれぞれ手順が異なります。
+未翻訳ページの新規翻訳作業と既存ページの修正作業でそれぞれ手順が異なります。いずれの場合も、編集したページに対して、[Hugo](https://gohugo.io)のレンダリングが問題なくできているかどうかをローカル環境で確認しましょう。

 既存ページへの追加修正については、後述の[マイルストーンについて](#milestones)に目を通すことをおすすめします。

@@ -152,6 +152,15 @@ cron「の」ジョブは、「の」が続く事による解釈の難から基
 - 訳で難しい・わからないと感じたらSlackの#kubernetes-docs-jaでみんなに聞く
 - できることを挙手制で、できないときは早めに報告

+### Markdown記法に関する注意事項
+
+- 原則として、翻訳元のMarkdown記法に従うこととするが、記法を変更した方が適切な場合はこの限りではない
+- 強調表現でアンダースコアを使うときは、基本的には前後に空白文字を入れる(例: `これは _斜体_ です`)
+    - 詰めて記述すると、`<em>`や`<strong>`に変換されないことがあるため
+- メイリオフォントは、日本語文字が斜体にならない仕様のため、次のような方法で確認する
+    - ブラウザのフォント設定で、別のフォントに変更する
+    - Firefoxを使う(Firefoxはメイリオでも斜体になるよう対処されている)
+
 ## アップストリームのコントリビューター

 SIG Docsでは、英語のソースに対する[アップストリームへのコントリビュートや誤りの訂正](/docs/contribute/intermediate#localize-content)を歓迎しています。