WordPressハンドブック翻訳で必須？な『wp-handbook-converter』

WordPressハンドブックの翻訳に取り組もうとすると、これを導入してくれ、と指定されてるのが、npmモジュール『wp-handbook-converter』。以下、これのReadme（2022-07-28更新版）の私家版和訳です。

wp-handbook-converter

https://github.com/mirucon/wp-handbook-converter

説明

特定のタイプのWordPressハンドブック内のすべてのページをマークダウンファイルに変換します。

インストール

$ npm i -g wp-handbook-converter

# Or

$ yarn global add wp-handbook-converter

パッケージをインストールせずにコマンドを実行したい場合は、次のようにしてください：$ npx wp-handbook-converter

※訳者注…npm、yarn、どちらもインストール先を「グローバル」と指定してます。

コマンドオプション

• -t, --team <team>：チーム名を指定する。

• -b, --handbook <handbook>：ハンドブック名を指定する（デフォルトは“handbook”）。

• -s, --sub-domain <sub-domain>：サブドメイン名を指定する。例えば、developer.w.orgなら“developer”、w.orgなら“w.org”（デフォルトは“make”）。

• -o, --output-dir <output-dir>：ファイルを保存するディレクトリを指定する（デフォルトはen/）。

• -r, --regenerate：このオプションが与えられると、出力ディレクトリとして指定されたディレクトリはいったん削除され、ディレクトリ内のすべてのファイルが再生成される。

例

コアコントリビューターハンドブックの入手

$ wp-handbook-converter --team core

※訳者注…チーム名：core

Meetupオーガナイザー・ハンドブックの入手

$ wp-handbook-converter --team community --handbook meetup-handbook

※訳者注…チーム名：community、ハンドブック名：meetup-handbook

テーマハンドブックの入手

$ wp-handbook-converter --handbook theme-handbook --sub-domain developer

※訳者注…ハンドブック名：theme-handbook、サブドメイン名：developer

プラグイン・ハンドブックの入手

$ wp-handbook-converter --handbook plugin-handbook --sub-domain developer

※訳者注…ハンドブック名：plugin-handbook、サブドメイン名：developer

※訳者注：WordPress「プラグイン開発ハンドブック」の和訳に乗り出そうで書いた様に、プラグインハンドブック翻訳プロジェクトに乗り出そうと言う場合だと、オプションは「ハンドブック名：plugin-handbook、サブドメイン名：developer、ファイル保存先：plugins、再生成：する」となる。

$ wp-handbook-converter --handbook plugin-handbook --sub-domain developer --output-dir plugins --regenerate

Last updated: Jul 28, 2022