# Gate your CI/CD pipeline on broken doc links

**Use case:** 

Checks the TypeScript repo README for broken hyperlinks, images and anchors, then fails the run if any dead link is found — so you can wire it straight into a pre-deploy CI/CD step. 403 and 429 responses are treated as alive to avoid false positives from bot-blocking sites. Returns a per-link report and a SUMMARY record. Swap in your own raw Markdown URL.

## Input

```json
{
  "markdownUrls": [
    "https://raw.githubusercontent.com/microsoft/TypeScript/main/README.md"
  ],
  "markdownText": "",
  "ignorePatterns": [],
  "additionalAliveStatusCodes": [
    "403",
    "429"
  ],
  "checkAnchors": true,
  "timeoutSeconds": 10,
  "retries": 1,
  "concurrency": 10,
  "userAgent": "Mozilla/5.0 (compatible; MarkdownBrokenLinksChecker/1.0; +https://apify.com/parsebird/markdown-broken-links-checker)",
  "failOnDeadLinks": true
}
```

## Output

```json
{
  "source": {
    "label": "Source",
    "format": "text"
  },
  "line": {
    "label": "Line",
    "format": "number"
  },
  "linkText": {
    "label": "Link Text",
    "format": "text"
  },
  "url": {
    "label": "URL",
    "format": "link"
  },
  "status": {
    "label": "Status",
    "format": "text"
  },
  "statusCode": {
    "label": "HTTP Code",
    "format": "number"
  },
  "errorMessage": {
    "label": "Error",
    "format": "text"
  },
  "isImage": {
    "label": "Image",
    "format": "boolean"
  },
  "checkedAt": {
    "label": "Checked At",
    "format": "text"
  }
}
```

## About this Actor

This example demonstrates how to use [Markdown Broken Links Checker](https://apify.com/parsebird/markdown-broken-links-checker.md) with a specific input configuration. Visit the [Actor detail page](https://apify.com/parsebird/markdown-broken-links-checker.md) to learn more, explore other use cases, and run it yourself.


## How to integrate an Actor?

If asked about integration, you help developers integrate Actors into their projects.
You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready.
This Task's input is already configured above — use it as-is rather than inventing a new one.

- **AI agents and MCP clients** — the [Apify MCP server](https://docs.apify.com/integrations/mcp.md) at `https://mcp.apify.com` (remote, streamable HTTP, OAuth on first use).
- **Agentic workflows and local Actor development** — [Agent Skills](https://apify.com/.well-known/agent-skills/index.json) with the [Apify CLI](https://docs.apify.com/cli/docs.md): `npm install -g apify-cli`, then `apify login`.
- **JavaScript/TypeScript projects** — the official [JS/TS client](https://docs.apify.com/api/client/js/docs.md): `npm install apify-client`.
- **Python projects** — the official [Python client](https://docs.apify.com/api/client/python/docs.md): `pip install apify-client`.
- **Any other language** — the [REST API](https://docs.apify.com/api/v2.md).

For full API examples (JavaScript, Python, CLI, MCP, OpenAPI), see this Task's Actor page: https://apify.com/parsebird/markdown-broken-links-checker.md

For more details, see Apify documentation as [Markdown index](https://docs.apify.com/llms.txt) and [Markdown full-text](https://docs.apify.com/llms-full.txt).