# zeal_docsets v0.1.7 - Table of Contents

Generate offline Zeal/Dash docsets from a Mix project's direct Hex dependencies and extra Hex packages.

## Pages

- [ZealDocsets](readme.md)
- [Changelog](changelog.md)

## Modules

- [ZealDocsets](ZealDocsets.md): `ZealDocsets` generates offline documentation bundles (docsets) for
[Zeal](https://zealdocs.org/) and [Dash](https://kapeli.com/dash) from
the direct Hex dependencies of any Mix project.
- [ZealDocsets.CLI](ZealDocsets.CLI.md): Shared argument parsing and report rendering helpers used by
`mix zeal.docs`.
- [ZealDocsets.Dep](ZealDocsets.Dep.md): Represents a resolved package selected for docset generation.
- [ZealDocsets.Docset](ZealDocsets.Docset.md): Orchestrates the construction of a `.docset` bundle for a single dependency.
- [ZealDocsets.HTML](ZealDocsets.HTML.md): Utility helpers for extracting text and attributes from Floki-parsed HTML.

- [ZealDocsets.HexPm](ZealDocsets.HexPm.md): Fetches package metadata from the Hex.pm API.
- [ZealDocsets.Hexdocs](ZealDocsets.Hexdocs.md): Downloads and mirrors documentation from hexdocs.pm using a BFS crawler.
- [ZealDocsets.Index](ZealDocsets.Index.md): Builds the SQLite search index (`docSet.dsidx`) for a Zeal/Dash docset.
- [ZealDocsets.Project](ZealDocsets.Project.md): Reads a Mix project's direct dependencies and their locked versions.
- [ZealDocsets.Runner](ZealDocsets.Runner.md): Coordinates dependency selection and docset generation for a target project.
- [ZealDocsets.Workspace](ZealDocsets.Workspace.md): Manages the workspace directory used for downloads and generated docsets.

## Mix Tasks

- [mix zeal.docs](Mix.Tasks.Zeal.Docs.md): Generates Zeal/Dash-compatible docsets for the direct Hex dependencies of the
current Mix project, with optional extra Hex packages requested explicitly.

