---
title: Has .md or .mdx mirror
description: A markdown mirror at <page>.md is the cleanest format an agent can ingest — no HTML, no scripts, no styling, just the content. Mirrors are a small amount of work to generate but dramatically reduce the cost of ingesting a doc site.
doc_version: 0.2.0
last_updated: "2026-04-24T21:30:56.217Z"
---

## How the check decides

The check derives a markdown URL by stripping any trailing slash and `.html` from the page path and appending `.md`, then `.mdx`. It sends a `HEAD` request and asserts a 2xx response. Fails if neither variant returns 2xx.

## How to implement it

Add a build step that emits a markdown version of every page alongside the HTML. Most modern SSGs already have an "export markdown" plugin or expose the source markdown directly via a route. The mirror should match the HTML page's URL with a `.md` extension.

### Pass

```text
GET /docs/install.md → 200 OK
```

### Fail

```text
GET /docs/install.md → 404 Not Found
GET /docs/install.mdx → 404 Not Found
```

## Sitemap

Full docs site index: [/sitemap.md](/sitemap.md).