The Wire · Showcase
HEXDOCS URL FORMAT SHIFT LANDS IN ELIXIR CORE
By RepoJournal · Filed · About Elixir & Phoenix
Elixir is standardizing on package.hexdocs.pm URLs, replacing the older hexdocs.pm/package format across the ecosystem.
The change [1] updates how Elixir references documentation links, moving to a subdomain-based URL structure that aligns with modern hex.pm conventions. This is a subtle but important shift for anyone generating docs programmatically or maintaining tooling that parses or generates hexdocs links. The old format still works, but new code should adopt the package.hexdocs.pm pattern going forward. Expect hex-adjacent tools and doc generators to follow suit over the next few releases.
One email a day. Unsubscribe in one click.
Keep up with Elixir & Phoenix in about 3 minutes a day: what actually shipped — the commits, pull requests, releases, and security advisories that matter.
One email a day. Unsubscribe in one click. Read a past issue →
Action items
- → Review doc generation tooling for hardcoded hexdocs.pm/package URLs elixir-lang/elixir [plan]
- → Update any custom doc link builders to use package.hexdocs.pm format elixir-lang/elixir [monitor]
References
- [1] Use package.hexdocs.pm URL format instead of hexdocs.pm/package (#15429) elixir-lang/elixir