Repository navigation
Enable Markdown documentation with the latest ExDoc plugin - #152
Merged
josevalim merged 2 commits intoSep 30, 2026
Merged
Conversation
josevalim
reviewed
Sep 30, 2026
Contributor
|
💚 💙 💜 💛 ❤️ |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
rebar3_ex_docto its latest release,0.3.0.rebar3 docsto generate HTML, Markdown, and EPUB documentation, includingllms.txt.RELEASE.md.The latest Rebar3 plugin bundles ExDoc
0.40.3, which supports Markdown. ExDoc0.40.4is newer, but the plugin does not bundle it yet.The plugin explicitly requests HTML and EPUB by default. The alias adds the Markdown formatter while preserving both existing formats. Its explicit
defaultnamespace also works when the Hex provider invokes it.rebar.lockremains unchanged because the project has no application dependencies, and Rebar3 does not lock project plugins there.Verification
With Rebar3 3.27.0:
rebar3 compile: passed on OTP 27 and 28.rebar3 ct --cover: all 42 tests passed on OTP 27 and 28.rebar3 xref: passed on OTP 27 and 28.rebar3 dialyzer: passed on OTP 28.rebar3 docs: generated HTML, Markdown, and EPUB on OTP 28.rebar3 hex build docs: built the documentation archive on OTP 27 and 28.llms.txt.llms.txt, HTML, and EPUB.git diff --check.Documentation generation still reports an existing invalid type link in
CHANGELOG.md:32(telemetry:span_function/0). The original configuration reports the same warning. This PR leaves that unrelated link unchanged.