drush mk:docs コマンド

drush の mk:docs コマンドについて：

コマンドヘルプ

サイト上で利用できる各 Drush コマンドのマークダウン（markdown）ドキュメントを作成する。

このコマンドは静的サイト www.drush.org を作成する初期段階です。自サイトで利用可能なコマンドの一覧を表示する、同様のサイトを作成する際に利用できます。Github Actions workflow も参照してください。

使用例

drush mk:docs --destination=commands
.md ファイル群を docs/commands ディレクトリに作成する。

オプション

--destination=DESTINATION
コマンドドキュメントの書き込み先を 'docs' ディレクトリを基準とする相対パスで指定する。

訳注

実際にこのコマンドを実行するには、対象となる Drupal プロジェクトのディレクトリ直下に mkdocs_base.yml ファイルが必要と思われます（ないとエラーが表示される）。

このファイルを取得してから実行すると、当該 Drupal プロジェクトで利用できる全 Drush コマンド（コア＋追加モジュール）のヘルプの .md ファイルが出力されます。

実行例：

# そのまま実行するとエラーになる
$ drush mk:docs --destination=commands

In Parser.php line 53:

  File "/var/www/std/mkdocs_base.yml" does not exist.

mk:docs [--destination DESTINATION] [-h|--help] [-q|--quiet] [-v|vv|vvv|--verbose] [-V|--version] [--ansi] [--no-ansi] [-n|--no-interaction] [-d|--debug] [-y|--yes] [--no] [--remote-host REMOTE-HOST] [--remote-user REMOTE-USER] [-r|--root ROOT] [-l|--uri URI] [--simulate] [--pipe] [-D|--define DEFINE] [--druplicon] [--notify] [--xh-link XH-LINK] [--] <command>

# mkdocs_base.yml を取得する
$ wget https://raw.githubusercontent.com/drush-ops/drush/10.x/mkdocs_base.yml

# 再度実行すると今度は成功
$ drush mk:docs --destination=commands

#  docs/command の下を見ると .md ファイルが生成されている
$ ls -l docs/commands
total 444
-rw-rw-r--. 1 vagrant vagrant 3723 Jan 14 22:10 all.md
-rw-rw-r--. 1 vagrant vagrant 1187 Jan 14 22:10 browse.md
-rw-rw-r--. 1 vagrant vagrant 1004 Jan 14 22:10 cache_clear.md
-rw-rw-r--. 1 vagrant vagrant 1286 Jan 14 22:10 cache_get.md
…

生成された markdown ファイルは、リファレンス（のソース）として利用できます。

生成された markdown ファイル