Freedom251 › Documentation Generators
ExDoc

What ExDoc is
ExDoc generates documentation for Erlang and Elixir projects, including API references and versioned documentation. It accepts Elixir, Erlang, Markdown, Livebooks, cheatsheets, and plain text, then produces offline-accessible HTML, Markdown—including llms.txt—and EPUB files. You can run it with Mix, Rebar or Rebar3, or the command line. Mix requires Elixir v1.15 or later; the documentation describes Erlang use with Rebar from Erlang/OTP 24 onward. Generated pages provide full-text search, keyboard shortcuts, autocomplete search, responsive layouts, and browser-preference night mode. Authors can add custom pages, guides, Livebooks, cheatsheets, grouped sidebars, logos, and favicons. Erlang and Elixir syntax highlighting is included, with other languages available through Makeup packages. HexDocs hosting can configure version dropdowns and latest-version notifications. ExDoc is free and its source uses the Apache 2 License, while rendered content may have other licenses.
Who it suits
ExDoc suits developers maintaining Erlang or Elixir projects who need API references, versioned docs, and multiple output formats. It also fits teams combining code and written source materials.
What it does well
- Generates HTML, Markdown, and EPUB documentation
- Supports Erlang and Elixir API references
- Includes search, autocomplete, and keyboard shortcuts
- Offers custom pages, guides, and sidebars
- Free plan available
What to know first
- Mix requires Elixir v1.15 or later
- Erlang setup documentation targets OTP 24 onward
- Rendered content may have different licenses
- Rendered materials must visibly link to ExDoc's repository
Verdict
ExDoc covers documentation generation, navigation, customization, and versioning for Erlang and Elixir workflows. Its free availability and varied inputs make it practical for projects already using those ecosystems.
Facts from ExDoc's own pages
- Build integrations
- ExDoc can be used with Mix, Rebar, or from the command line. · ex-doc.hexdocs.pm, 8 Oct 2026
- Custom content
- It supports custom pages, guides, Livebooks, and cheatsheets. · ex-doc.hexdocs.pm, 8 Oct 2026
- Customization
- ExDoc supports custom pages, guides, Livebooks, cheatsheets, custom sidebar grouping, and customizable logos and favicons. · ex-doc.hexdocs.pm, 8 Oct 2026
- Elixir requirement
- Using ExDoc with Mix requires Elixir v1.15 or later. · ex-doc.hexdocs.pm, 8 Oct 2026
- Erlang requirement
- For Erlang projects, the page recommends Rebar and says ExDoc can render EDoc documentation from Erlang/OTP 24 onward. · ex-doc.hexdocs.pm, 8 Oct 2026
- Generated documentation condition
- Generated documentation and derivative works must include a direct, readable, visible link to the ExDoc repository on each rendered material. · ex-doc.hexdocs.pm, 8 Oct 2026
- HexDocs integration
- When hosted on HexDocs, ExDoc automatically configures version dropdowns and notifications to go to the latest version. · ex-doc.hexdocs.pm, 8 Oct 2026
- Integrations
- ExDoc can be used with Mix, Rebar3, or through its command line interface. · ex-doc.hexdocs.pm, 8 Oct 2026
- Intended users
- The project describes ExDoc as a tool for generating documentation for Erlang and Elixir projects. · github.com, 8 Oct 2026
- License
- ExDoc source code is released under the Apache 2 License, while generated contents may have different licenses based on rendering components. · ex-doc.hexdocs.pm, 8 Oct 2026
- Navigation and search
- Features include full text search, keyboard shortcuts, autocomplete search, and links to HexDocs package documentation. · ex-doc.hexdocs.pm, 8 Oct 2026
- Output formats
- It can generate offline accessible HTML, Markdown including llms.txt, and EPUB documents from API documentation. · ex-doc.hexdocs.pm, 8 Oct 2026
- Presentation
- Generated documentation supports responsive layouts, night mode, customizable logos and favicons, and custom sidebar grouping. · ex-doc.hexdocs.pm, 8 Oct 2026
- Purpose
- ExDoc generates documentation for Erlang and Elixir projects. · ex-doc.hexdocs.pm, 8 Oct 2026
- Reader features
- Generated docs include full text search, keyboard shortcuts, quick search with autocomplete, and night mode based on browser preference. · ex-doc.hexdocs.pm, 8 Oct 2026
- Requirements
- The Mix setup requires Elixir v1.15 or later; the README describes Rebar3 use from Erlang/OTP 24 onward. · ex-doc.hexdocs.pm, 8 Oct 2026
- Security and privacy
- The page does not state security certifications or privacy practices. · ex-doc.hexdocs.pm, 8 Oct 2026
- Source links
- ExDoc can include a direct link to source code for every documented entity. · ex-doc.hexdocs.pm, 8 Oct 2026
- Syntax highlighting
- Erlang and Elixir highlighters are included by default, and other languages can be supported by adding the corresponding Makeup package. · ex-doc.hexdocs.pm, 8 Oct 2026
Where ExDoc stands on Freedom251
- Documentation Generators#27 of 37
