Read GitCafe as Markdown#

Every guide, and most repository pages, can be read as Markdown. This is handy for scripts, coding agents and anything that prefers text to HTML.

Get the Markdown version of a page#

Add ?format=markdown to the address (or &format=markdown if it already has a query), or send Accept: text/markdown. Guides also have a .md address, such as /docs/getting-started/quickstart.md.

The same permissions apply as in the browser: private repositories need you to be signed in and otherwise answer 404. A page with no Markdown version answers 406.

Start from llms.txt#

• /llms.txt lists every guide and site page.
• /llms-full.txt contains all of them in one file.
• /<owner>/<repo>/llms.txt summarizes a repository: its description, default branch, root files, the start of its README, and links to its code, history, issues and pull requests.

Repository addresses#

• Directory: /<owner>/<repo>/tree/<revision>/<path> (omit <path> for the root).
• File: /<owner>/<repo>/blob/<revision>/<path>.
• History: /<owner>/<repo>/commits/<revision>.
• Commit: /<owner>/<repo>/commit/<sha>.

A revision can be a branch, a tag, a commit SHA or a full ref; write slashes inside a ref as %2F (refs%2Fheads%2Fmain). Links in a document point at the exact commit it was made from, so the files you follow match what you read.

Limits#

Markdown documents are summaries, not full exports:

• History shows 100 commits per page; issue, pull request and stack lists show 30, open items by default; owner repository lists show 20; branch and tag lists show 100.
• A pull request's commits and diffs show 20 files or commits per page, with notices for binary or very large files.
• Discussions, reviews and checks link to the browser instead of being copied.

Follow a document's Next page link unchanged to continue.