Glossary

What is Markdown for agents?

Also called: Markdown alternate, Accept: text/markdown

A Markdown copy is a plain-text version of a page. A tool asks for it with the request header Accept: text/markdown, and the page answers with Markdown instead of the normal page.

Why it matters

A few tools prefer plain text because it is lighter to read. A normal page that tools can read works just as well, so this is optional.

How Onbiom checks it

"Your page has a plain-text copy" asks your homepage for text/markdown. It passes when the answer is 200, marked text/markdown, and not empty. A missing copy is not a fault.

"Your plain-text copy matches the page" checks the answer is at least 5 words, does not look like a web page (does not start with a tag) and shares a word of 4 or more letters with your page title. It fails when it does not. If your page points to a Markdown copy but does not answer the request, the result is not checked.

In your report this appears as: Optional Markdown representation; Markdown copy of the page.

How to check it yourself

  1. Run the command below and see if the reply is plain text.
  2. If not, that is fine unless a tool you care about needs it.
curl -s -H 'Accept: text/markdown' https://example.com/ | head -n 20

Not sure about your own site? Paste your address and see in a minute which of these checks your site passes. Free, no account needed.

Check your site

How to fix it

Any website
Only add this if a tool you care about asks for it, and keep the copy the same as the normal page.
Ask your web person
Return Markdown when a request asks for text/markdown, for example through your server or a plugin.

Related terms

Sources and further reading

Last reviewed: