ex_doc
ExDoc generates HTML and EPUB documentation for Elixir and Erlang projects with offline access, search, and custom pages.
What is ex_doc?
ExDoc is a documentation generation tool for Elixir and Erlang projects that produces HTML and EPUB documentation from source code and Markdown files. It solves the problem of creating professional, accessible, and searchable documentation for libraries and applications in the BEAM ecosystem. It integrates with Mix and Rebar3 to automatically extract API details and supports custom pages, guides, and interactive content.
Elixir and Erlang developers who need to generate and maintain high-quality documentation for their libraries, applications, or open-source projects. It's particularly useful for projects published on Hex.pm that want to host documentation on HexDocs.
Developers choose ExDoc because it's the official, battle-tested tool for the Elixir/Erlang ecosystem, offering a seamless integration with build tools, beautiful default themes, and extensive customization options. Its ability to generate offline-accessible docs with full-text search and cross-linking between dependencies sets it apart from basic documentation generators.
Overview
ExDoc produces HTML and EPUB documentation for Elixir projects
Use Cases
Best For
- Generating HTML documentation for Elixir libraries published on Hex.pm
Found a gem we're missing?
Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.