記事編集ガイドライン - Siv3D/Reference-JP GitHub Wiki

随時加筆修正します。疑問点は Slack の #reference チャンネルでコメントしてください。

タイトル

  • ページのタイトルは "Title" 欄に記述する。記事内に書く必要はない
  • "Title" を変更するとページの URL が変わってしまう。変更時は Slack で相談
  • ⚠️ タイトルが重複するとどうなる？（未確認）

文章

  • 通常の文章は「です・ます調」
  • 句読点は「、」「。」
  • 半角英数の直後の句読点は「,」「.」
  • 「！」「？」の使用は少なめに
  • 「！」「？」の全半角は直前の単語に合わせる
  • 半角英数の単語や絵文字と日本語の間には半角スペースを入れる
    例: Siv3D は C++ ライブラリです ♋
  • 特別に注意が必要な項目は :warning: 絵文字 ⚠️ を先頭に入れる

箇条書き・数字リスト

  • Markdown 記法を使う
  • 文体は簡潔に
  • 末尾に「。」「.」は使わない

コード

```cpp
ソースコードをここに書く
```
  • シンタックスハイライト機能を使う
  • なるべくコードのコピペだけで実行できるようにする

画像

  • リポジトリ外の画像は使用しない
  • 画像フォーマットは PNG または GIF アニメーション
  • PNG は PNGGauntlet を使って最大限まで圧縮
  • GIF アニメーションは 1.0 MB 以下
  • ファイル名は CamelCase.xxx
  • 連番の場合は CamelCase-1.xxx, CamelCase-2, ...
  • さらに細かく分ける場合は CamelCase-1-1.xxx, CamelCase-1-2, ...
  • ⚠️ 記事に画像を埋め込む際に ![](パス) は使わない。
    ページロード時に画像の高さが確定せず、リンクをクリックして記事内の項目に飛んだとき、表示位置がずれてしまう。以下のように HTML を手打ちする。
<img src="URL(絶対パス)" width="幅px" height="高さpx">

例:

<img src="https://github.com/Siv3D/Reference-JP/blob/master/resource/technique/Text/MessageBox.gif?raw=true" width="640" height="480">

学習コース

目次

<table>
<tr>
<td colspan="2"><b>タイトル</b>　EMOJI(:seedling: :herb: :deciduous_tree:) Level(Beginner/Intermediate/Advanced)　|　<a href="#">筆者</a></td>
</tr>
<tr>
<td width="230"><a href="#"><img src="" width="200" height="150"></a></td>
<td>説明。説明。説明。説明。説明。説明。説明。説明。説明。説明。説明。説明。説明。説明。説明。説明。説明。説明。説明。説明。説明。説明。説明。説明。説明。説明。説明。説明。説明。説明。説明。説明。説明。説明。説明。説明。説明。
<br><br>キーワード: Sound, GUI</td>
</tr>
</table>

記事

<table>
<tr>
<td colspan="2">このコースの筆者</td>
</tr>
<tr>
<td><img src="" width="128" height="128"></td>
<td><b>名前</b>
<br>自己紹介の文章。自己紹介の文章。自己紹介の文章。自己紹介の文章。自己紹介の文章。自己紹介の文章。自己紹介の文章。自己紹介の文章。自己紹介の文章。自己紹介の文章。自己紹介の文章。自己紹介の文章。</td>
</tr>
</table>
⚠️ **GitHub.com Fallback** ⚠️