Github で執筆する作用を行うためのテンプレートリポジトリ。
Github Actions を使って lint で校正して re:VIEW 経由で PDF にする。
feature/ から始まるリポジトリは push をトリガーにPDFを作成します。
master release-candidate リポジトリはプルリクエストをトリガーにPDFを作成します。
PDFの作成に成功した場合は Releases に PDF をアップロードします。
docs ディレクトリに md ファイル、画像ファイルを images ディレクトリには配置する。
catalog.yml を自動生成するのでmdファイルをわけて管理する場合は、ファイルの命名を意識しないと意図した並びにならない。
並び順を明示的に指定したい場合は、.github/workflows/create_pdf.yml の catalog.yml の自動生成をやめて自分で出力順をメンテナンスしてください。
以下の内容をチェックします。
- aws-spellcheck
- preset-ja-technical-writing
- spellcheck-tech-word
以下の拡張機能を導入しています。
ファイルの保存時にフォーマットをかけるようにしているのでlintで修正可能なものは自動修正します。