開発ログを書くときの Markdown 記法ガイド
見出し・リスト・リンク・コード・引用・表に加え、画像・動画のサイズ指定まで、開発ログを書くときに使える Markdown 記法を一通りまとめました。執筆時のチートシートとしてご活用ください。
はじめに
GameWith Indie の開発ログ本文は、Markdown で書けます。 このページでは、執筆時に使える主な記法を「書き方」と「表示結果」のセットで紹介します。 コードブロックの中身をそのままコピーして書き換えれば、同じように表示されます。
見出し
セクション見出しには ##、その中の小見出しには ### を使います。
記事タイトルは別枠で表示されるため、本文中で # ひとつの見出しは使いません。
書き方:
表示結果は、このページの「## 見出し」と下の「### これは小見出しの例です」のとおりです。
これは小見出しの例です
段落と強調
段落は 空行で区切ります。 強調や打ち消し線、インラインコードは、文の途中で使えます。
書き方:
表示結果:
段落は 空行で区切ります。
文中では 斜体 や 太字、打ち消し線、インラインコード を使えます。
リンク
リンクの貼り方は3通りあります。
書き方:
表示結果:
- インラインリンク: GameWith Indie
- 山かっこ記法: https://indie.gamewith.jp
- そのまま URL: https://indie.gamewith.jp
3つともリンクとして表示されます。
箇条書き
書き方:
表示結果:
- ジャンル: アクション
- プラットフォーム: PC / Switch
- 価格: 未定
番号付きリスト
書き方:
表示結果:
- プロトタイプを作る
- プレイテストを集める
- フィードバックを反映する
ネストしたリスト
行頭を半角スペース2つでインデントすると、ネストできます。
書き方:
表示結果:
- 開発フェーズ
- 企画
- プロトタイピング
- リリース後
- パッチ配信
引用
行頭に > を書くと引用ブロックになります。開発者の言葉や、他メディアからの引用を載せたいときに使えます。
書き方:
表示結果:
インディーゲームに大切なのは、最初のひと触りで「これは自分のためのゲームだ」と思ってもらうこと。
コードブロック
バッククォート3つで挟むとコードブロックになります。先頭に ts や bash などの言語名を書くと、その言語に応じた色分けが入ります(このページの「書き方」ブロックも、すべてこの記法で書かれています)。
書き方:
表示結果:
表
縦棒 | で列を区切り、2行目に --- を書くと表になります。
書き方:
表示結果:
セル区切りの : の位置で、列ごとの寄せ方も指定できます。
書き方:
表示結果:
区切り線
話題を切り替えたいときは --- を単独の行に書くと、水平線が入ります(このページの各セクション間にある横線がそれです)。
書き方:
表示結果:
ここで話題が変わります。
新しい話題です。
画像・動画のサイズ調整
開発ログ・記事に貼った画像や動画は、標準では本文の横幅いっぱいで表示されます。
画像・動画ショートコードの末尾に |w=600 のように幅(px)を付けると、その幅で表示できます。
縦長のスクリーンショットを控えめに見せたい、ロゴだけ小さく置きたい、といったときに使ってください。
幅を指定しない場合(本文幅いっぱい):
幅 600px を指定した場合:
幅 300px を指定した場合:
動画も同じように幅を指定できます。下は幅 480px を指定した例です。
スマホなど画面が指定幅より狭いときは、画面幅に合わせて自動で縮みます。
ゲーム紹介カードの埋め込み
「ゲームを挿入」ボタンを押して GameWith Indie 内のゲームを選ぶと、その紹介カードを本文に差し込めます。
公開中のゲームのみ表示されます(非公開・削除されたゲームは表示されません)。
まとめ
ここで紹介したのは、Markdown のごく基本的な記法だけです。 迷ったときはこのページを見返して、「書き方」のコードブロックをコピーして書き換えるのが早道です。 皆さんの開発ログを楽しみにしています。
