ExDoc

Spec sheet

Purpose

ExDoc generates documentation for Erlang and Elixir projects.Read 8 Oct 2026 · ex-doc.hexdocs.pm

Intended users

The project describes ExDoc as a tool for generating documentation for Erlang and Elixir projects.Read 8 Oct 2026 · github.com

Integrations

ExDoc can be used with Mix, Rebar3, or through its command line interface.Read 8 Oct 2026 · ex-doc.hexdocs.pm

License

ExDoc source code is released under the Apache 2 License, while generated contents may have different licenses based on rendering components.Read 8 Oct 2026 · ex-doc.hexdocs.pm

Build integrations

ExDoc can be used with Mix, Rebar, or from the command line.Read 8 Oct 2026 · ex-doc.hexdocs.pm

Custom content

It supports custom pages, guides, Livebooks, and cheatsheets.Read 8 Oct 2026 · ex-doc.hexdocs.pm

Customization

ExDoc supports custom pages, guides, Livebooks, cheatsheets, custom sidebar grouping, and customizable logos and favicons.Read 8 Oct 2026 · ex-doc.hexdocs.pm

Elixir requirement

Using ExDoc with Mix requires Elixir v1.15 or later.Read 8 Oct 2026 · ex-doc.hexdocs.pm

Erlang requirement

For Erlang projects, the page recommends Rebar and says ExDoc can render EDoc documentation from Erlang/OTP 24 onward.Read 8 Oct 2026 · ex-doc.hexdocs.pm

Generated documentation condition

Generated documentation and derivative works must include a direct, readable, visible link to the ExDoc repository on each rendered material.Read 8 Oct 2026 · ex-doc.hexdocs.pm

HexDocs integration

When hosted on HexDocs, ExDoc automatically configures version dropdowns and notifications to go to the latest version.Read 8 Oct 2026 · ex-doc.hexdocs.pm

Navigation and search

Features include full text search, keyboard shortcuts, autocomplete search, and links to HexDocs package documentation.Read 8 Oct 2026 · ex-doc.hexdocs.pm

Output formats

It can generate offline accessible HTML, Markdown including llms.txt, and EPUB documents from API documentation.Read 8 Oct 2026 · ex-doc.hexdocs.pm

Presentation

Generated documentation supports responsive layouts, night mode, customizable logos and favicons, and custom sidebar grouping.Read 8 Oct 2026 · ex-doc.hexdocs.pm

Reader features

Generated docs include full text search, keyboard shortcuts, quick search with autocomplete, and night mode based on browser preference.Read 8 Oct 2026 · ex-doc.hexdocs.pm

Requirements

The Mix setup requires Elixir v1.15 or later; the README describes Rebar3 use from Erlang/OTP 24 onward.Read 8 Oct 2026 · ex-doc.hexdocs.pm

Security and privacy

The page does not state security certifications or privacy practices.Read 8 Oct 2026 · ex-doc.hexdocs.pm

Source links

ExDoc can include a direct link to source code for every documented entity.Read 8 Oct 2026 · ex-doc.hexdocs.pm

Syntax highlighting

Erlang and Elixir highlighters are included by default, and other languages can be supported by adding the corresponding Makeup package.Read 8 Oct 2026 · ex-doc.hexdocs.pm

Where Specifiction places it

• Documentation Generators#30 of 377.0