# elixir-lang/ex_doc

ExDoc produces HTML and EPUB documentation for Elixir projects

Repository: https://github.com/elixir-lang/ex_doc
Canonical: https://ross.abutalabs.com/products/ex_doc
Homepage: http://elixir-lang.org
Language: Elixir
License: NOASSERTION
License Family: other
Last push: 2026-08-26T14:28:20+00:00

## Health v2 (maintenance only)
Score: 94/100 (v2, computed 2026-09-03T02:20:16.233290+00:00)
- activity 99, release rhythm 84, longevity 100
- inputs: {"age_days": 5293, "days_push": 7, "days_rel": 104, "gap_med": 13, "n_releases_24m": 24}
- flags: no_license
- formula: round(0.45*activity + 0.35*rhythm + 0.20*longevity); archived -> min(score, 10)

## Adoption (not part of the score)
Stars 1613, forks 367 (observed 2026-08-28T04:05:11.234275+00:00)

## What it is
ExDoc is a documentation generation tool for Elixir and Erlang projects that produces HTML, Markdown (including llms.txt), and EPUB output from API documentation. It is the tool behind HexDocs and Elixir's official documentation, with features like full-text search, version dropdowns, and source links.

## Use cases
- generate html documentation for an elixir project
- publish api docs to hexdocs
- produce epub offline documentation
- generate llms.txt markdown docs for a library
- add full-text search to project documentation
- document an erlang project with rebar3
- create guides and cheatsheets alongside api docs

## When to choose
- you maintain an Elixir or Erlang library or application and want standard HexDocs-style documentation
- you need offline-accessible HTML or EPUB docs generated from docstrings
- you want hosted docs with search, versioning, and source links out of the box

## When to avoid
- your project is not in the Elixir/Erlang ecosystem
- you need a different documentation format like PDF or man pages
- you want a general-purpose static site generator rather than API doc generation

## Facets
- artifact type: library
- maturity: active
- function: documentation, markdown, search-engine, cli
- domain: documentation, developer-tools, programming-languages
- platform: elixir, cross-platform
- tags: doc-generator, html, epub, hexdocs, elixir, erlang, api-docs

## Member repositories
- elixir-lang/ex_doc (main) score 94

## Provenance
- Observed fields: from GitHub, fetched 2026-08-28T04:05:11.234275+00:00.
- Health v2: computed from the inputs above; adoption is never an input.
- Inferred fields (summary, facets, guidance): AI-extracted, prompt v1, taxonomy v1, on 2026-08-30T03:51:05.756540+00:00, confidence not recorded.
  - readme: https://github.com/elixir-lang/ex_doc (fetched 2026-08-28T04:05:11.234275+00:00, sha 5dd9f527873e)
  - homepage: http://elixir-lang.org (fetched 2026-08-29T11:22:49.293321+00:00, sha 74e1f7dbafea)
  - site_page: https://elixir-lang.org/install (fetched 2026-08-29T11:22:49.303924+00:00, sha 036479bee24c)
  - site_page: https://elixir-lang.org/docs (fetched 2026-08-29T11:22:49.306295+00:00, sha acb15941abed)
- Data as of 2026-08-30T08:39:29.467469+00:00.
