Home

GitHub Pagesのデプロイ

Actions > Deploy to GitHub Pages > Run workflowを実行すると自動でビルドしてデプロイされる。

命名規則

• ファイル名/フォルダ名
  • 拡張子がtsx/cssのファイル名: Upper Camel Case
  • 上記以外: Chain Case
• HTMLのclass: Chain Case
• HTMLのid: Chain Case
• TypeScriptの変数関数: Lower Camel Case
• JSONのキー: Lower Camel Case

template.jsonの項目

• decorations: READMEを装飾するために用意したつもり（工事中）
• sections: フォームの各項目
  • title (string): 項目のタイトル
  • description (string): 項目の説明文
  • required (booleaan): 記入が必須かどうか
  • multiple (boolean): 複数枠記入が可能かどうか
  • hiddenTitle (boolean): READMEとして出力する時にタイトルを隠すかどうか
  • replacingTitle (boolean): READMEとして出力する時にタイトルを入力内容で置き換えるかどうか
  • formType (string): フォームに用いるReactのモジュールを指定
  • kindsOfValues (string[]): 入力内容の形式を配列で指定する（plainまたはfilePath）
  • formats (string[]): kindsOfValuesに対応しているそれぞれの入力内容をREADMEとして出力する際のフォーマット
  • attributes: フォームにつけるオプション
    • kindsOfFile (string[] | undefined): ファイル添付する際に許可するファイル形式
    • placeholder (string | undefined): 入力欄のプレースホルダー
    • maxLength (number | undefined): 入力欄の最大入力文字数
  • script (string | undefined): Auto Fillする際に利用するスクリプトの指定

scriptの仕様

• 引数は[レポジトリのURL]
• 戻り値はtitleとvaluesを含めたオブジェクト
• 中でGitHub APIにアクセスしたり、独自の何かエンジンを通していい感じに値を加工してtitleとvaluesのオブジェクトを生成する

フローチャート

1. トップページでリポジトリのURLを入力する
2. Nextボタンを押すと編集画面（Editor）に遷移する
3. Auto Fillにチェックが入っていた場合にはフォームに自動入力される
4. フォームを埋めていく
5. Generateボタンを押す
6. 必要事項が記入されていればそのままREADMEのzipがダウンロードされる
7. 必要事項が未記入の場合Confirmダイアログが出るがそれでもOKするとREADMEのzipがダウンロードされる