Generate Markdown documentation with ExDoc 0.40.3 - #85
Open
BobbieBarker wants to merge 1 commit into
Open
BobbieBarker wants to merge 1 commit into
BobbieBarker wants to merge 1 commit into
Conversation
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
Why
ExDoc 0.40 introduced native Markdown output and an
llms.txtindex. Publishing those artifacts on HexDocs gives documentation retrieval tools, MCP documentation servers, and coding agents a canonical machine-readable source instead of requiring them to scrape rendered HTML. Broader adoption makes Elixir library documentation easier to discover and use across the ecosystem.This keeps ConCache's existing HTML documentation intact while adding the Markdown pages and index. Once this is merged, please publish or republish the documentation at your earliest convenience so these artifacts become available on HexDocs and the community can benefit from them.
Compatibility
ExDoc remains a development-only dependency with
runtime: false, so this does not change ConCache's~> 1.7Elixir requirement, runtime dependency graph, or public API. Generated documentation is not committed.Verification
MIX_ENV=dev mix docsproduced HTML, with nollms.txtor Markdown pagesMIX_ENV=dev mix docsproduced HTML,llms.txt, and 5 Markdown pagesllms.txtresolves to a generated file (4/4)mix format --check-formattedmix deps.unlock --check-unusedmix dialyzer— 0 errorsMIX_ENV=test mix compile --warnings-as-errorsmix test— 68 tests, 0 failuresThe project checks above were run with Elixir 1.16.2, matching the repository's configured Elixir version.