記事投稿ルール

確認方法 => release まで

1. devel branch に データを保存 (commit on github)
2. devel 向けの環境の deploy
3. deploy された環境で確認
4. pull request を作成 (master 向け)
5. 承認

仕様できる 特殊な表現 tag / 表現一覧

>: 引用

```: Code Block

##, ###, ####: Heading

記事内の画像について

• 容量
  • なるべく容量を軽くする 1MB を最大容量とする。なるべく下げる。
• 解像度
  • 解像度は 幅 1200 px を上限とする (記事の最大幅が 600px のため)

ディレクトリの区分

• _news　お知らせ
• _release_notes　リリースノート
• _works　活用事例

活用事例のサムネイルについて

活用事例のサムネイルは 記事内の最初の画像が採用される

• 解像度
  • サムネイルの高さを合わせたいため 最初の画像は 16:9 => 幅 1200px の画像の場合 1200x675 の画像を推奨する

活用事例 - 企業ロゴについて

企業ロゴは public フォルダに入れた画像のパスを利用する

• ロゴを入れるフォルダ
  • github 上の public/logos/ 以下に画像を保存(commit してもらう)
• パス
  • md ファイルの 最初の設定の logo 属性に ファイル名を指定する
  • 例えば copilot.png の場合は
  • logo: 'copilot.png' を指定する
• 解像度
  • こちらも高さを合わせたいので、 高さを統一させる => 48px

目次の挿入方法

活用事例 / リリースノートでは、 タグに基づいた 目次を挿入できます。

• 目次の入れ方
  • 好きな場所に [docs] と記入する

リリースノート一覧のアイコン指定方法

リリースノート mdファイルのタイトルを指定している箇所に icon: "🐛" と指定することで、任意のアイコンを表示することが可能。 (""はなしでも指定可能)
icon を指定しないと ✨ がデフォルトで表示されます。

現在のアイコンルール

• 更新に関わる記事：✨
• 修正に関わる記事：🐛
• リリースに関わる記事：🎉

小規模な更新(機能追加、改修)は「更新」とし、大まかな変更(サービスの提供開始、大幅な機能改善など)は「リリース」を想定。 大規模なリリースというのは Project Sprint Method が体現されていたり、今までに全くなかった機能や大幅なデザインや機能の変更を想定。