mix zeal.docs (zeal_docsets v0.1.7)

Copy Markdown View Source

Generates Zeal/Dash-compatible docsets for the direct Hex dependencies of the current Mix project, with optional extra Hex packages requested explicitly.

When --extra-package is used without any --package filter, only the explicitly requested extra packages are built.

The supported workflow is to run this task from the target project's root and pass . as the project path. If zeal_docsets_path is omitted, the default Zeal directory for the current platform is used.

Usage

mix zeal.docs . [zeal_docsets_path] [options]

Examples

mix zeal.docs .
mix zeal.docs . ~/.local/share/Zeal/Zeal/docsets --dev
mix zeal.docs . --dev --test --force --concurrency 6
mix zeal.docs . --package phoenix --force
mix zeal.docs . --extra-package ecto
mix zeal.docs . --extra-package phoenix_live_view@1.1.16