Return Markdown for LLM driven User Agents

[mikehostetler]

Inspired by this tweet from Bun: https://x.com/bunjavascript/status/1971934734940098971

When a LLM Agent requests docs from HexDocs, return the Markdown representation instead of the HTML - with the purpose to shrink token usage.

[josevalim]

Is there an easy way for us to know if one is a LLM Agent or will we have to add one by one manually? 😬

[Valian]

Probably worth checking how Bun does it. 🤔

Still, there's another approach: accept header. Would be the easiest, if somehow agents would prioritize markdown over html when making request.

[foucist]

FYI opencode just added accept header for markdown sst/opencode@c148f10

[Valian]

Mintlify also added this. It seems to be based on accept header, Claude Code prefers text/plain over text/html:

https://x.com/rauchg/status/1972347470140379616

[ericmj]

If we want to serve markdown from hexdocs.pm the first step would be to have ex_doc include it alongside the html in the docs bundle that is uploaded to hexdocs.

After that we can update the hexdocs.pm to serve the markdown based on the accept header.

[brkn]

Not sure if this question is appropriate here or at hexpm/hex repo.

Is there a way to fetch the markdown version from command line, like the epub version?

mix hex.docs fetch phoenix 1.8.3 --format markdown