wiki

Description

The wiki command generates Markdown documentation using phpDocumentor. It is especially useful together with the reusable wiki workflow for GitHub wiki.

Usage

composer wiki
composer dev-tools wiki -- [options]
vendor/bin/dev-tools wiki [options]

Options

--target, -t (optional)

Path to the output directory for the generated Markdown documentation. Default: .github/wiki .

--cache-dir (optional)

Path to the cache directory for phpDocumentor. Default: .dev-tools/cache/phpdoc .

--cache

Force phpDocumentor caching on for this run.

--no-cache

Force phpDocumentor caching off for this run.

--init

Initialize the configured wiki target as a Git submodule.

--json

Emit a structured machine-readable payload instead of the normal terminal output.

--pretty-json

Emit the same structured payload with indentation for terminal inspection.

Examples

Generate wiki docs:

composer wiki

Generate to custom directory:

composer wiki --target=wiki

Initialize wiki as submodule:

composer wiki --init

Generate without cache:

composer wiki --no-cache

Exit Codes

Behavior

• Default output directory is .github/wiki .
• Cache stays enabled by default; omit both flags to keep the command default, pass --cache to force it on, and pass --no-cache to force it off.
• When --cache-dir is omitted, phpDocumentor keeps its default cache directory. The option only affects phpDocumentor when caching is enabled.
• Uses the Markdown template from vendor/saggre/phpdocumentor-markdown/themes/markdown .
• The --init option creates the wiki as a Git submodule pointing to the repository wiki.