フルビルドするには以下のコマンドを実行します。
make doc
差分ビルドするには以下のコマンドを実行します。
make doc-incremental
ビルドが正常に完了したら、以下のコマンドを実行するとローカルでウェブサーバが起動します。これによりビルドしたドキュメントをブラウザで確認できます。
make doc-serve
なお、ドキュメントのビルド時にMakefile内のclientターゲットで一部のコマンドをビルドするようになってます。 そのためincusのソースファイルも消さずに残してあります。
textlintについては以下の記事の参照してください。
Getting Started | Voltaの手順でVoltaをインストールし pnpm Support | Voltaの設定をしてください。
レポジトリ内で以下のコマンドを実行してください。
volta pin node@18
volta pin pnpm@latest
その後以下のコマンドを実行して、textlintとルールのパッケージをインストールします。
pnpm install
以下のコマンドでtextlintを実行してください。
npm run textlint
設定ファイルは .textlintrc.json にあります。
ルール一覧はCollection of textlint rule · textlint/textlint Wikiを参照してください。
prh/prh: proofreading helper用のルールはlxc-jp/textlint-prh-rules: A collection of prh rulesをgit submoduleで.textlint-prh-rules/に配置しています。