Search hexdocs

Search hexdocs.pm documentation.

Usage

{baseDir}/scripts/hexdocs.js <QUERY> [OPTIONS]

Examples

# Search all packages
{baseDir}/scripts/hexdocs.js "GenServer callbacks"

# Filter by package
{baseDir}/scripts/hexdocs.js "Ecto.Query" --packages ecto

# Multiple packages
{baseDir}/scripts/hexdocs.js "LiveView hooks" --packages phoenix_live_view,phoenix

# Limit results
{baseDir}/scripts/hexdocs.js "plug conn" --limit 5

# JSON output
{baseDir}/scripts/hexdocs.js "json encode" --packages jason --json

Output Format

Results: 42 (showing 10)

<result index="0" package="phoenix" ref="Phoenix.Controller.html#json/2" title="json/2">
Sends JSON response...
</result>