ZealDocsets (zeal_docsets v0.1.7)

Copy Markdown View Source

ZealDocsets generates offline documentation bundles (docsets) for Zeal and Dash from the direct Hex dependencies of any Mix project.

It reads mix.exs to discover which packages the project directly depends on, cross-references mix.lock for the exact locked versions, and can also include explicitly requested extra packages from Hex.pm. For each package it mirrors the HTML documentation from hexdocs.pm and packages it into a .docset bundle ready to be imported into Zeal.

Usage as a project dependency

# In the target project's mix.exs
{:zeal_docsets, "~> 0.1.6", only: [:dev, :test], runtime: false}

# Then inside the target project
mix zeal.docs . [zeal_docsets_path] [options]

See ZealDocsets.CLI for the full list of options.