Generate Reports · Nuxt Link Checker · Nuxt SEO

[NuxtSEO](https://nuxtseo.com/ "Home")

- [Modules](https://nuxtseo.com/docs/nuxt-seo/getting-started/introduction)
- [Tools](https://nuxtseo.com/tools)
- [Pro](https://nuxtseo.com/pro)
- [Learn SEO](https://nuxtseo.com/learn-seo/nuxt) [Releases](https://nuxtseo.com/releases)

[1.4K](https://github.com/harlan-zw/nuxt-seo)

[Nuxt SEO on GitHub](https://github.com/harlan-zw/nuxt-seo)

[User Guides](https://nuxtseo.com/docs/link-checker/getting-started/introduction)

[API](https://nuxtseo.com/docs/link-checker/api/config)

[Releases](https://nuxtseo.com/docs/link-checker/releases/v5)

Link Checker

- [Switch to Link Checker](https://nuxtseo.com/docs/link-checker/getting-started/introduction)
- [Switch to Nuxt SEO](https://nuxtseo.com/docs/nuxt-seo/getting-started/introduction)
- [Switch to Robots](https://nuxtseo.com/docs/robots/getting-started/introduction)
- [Switch to Sitemap](https://nuxtseo.com/docs/sitemap/getting-started/introduction)
- [Switch to OG Image](https://nuxtseo.com/docs/og-image/getting-started/introduction)
- [Switch to Schema.org](https://nuxtseo.com/docs/schema-org/getting-started/introduction)
- [Switch to SEO Utils](https://nuxtseo.com/docs/seo-utils/getting-started/introduction)
- [Switch to Site Config](https://nuxtseo.com/docs/site-config/getting-started/introduction)
- [Switch to Skew Protection](https://nuxtseo.com/docs/skew-protection/getting-started/introduction)
- [Switch to AI Ready](https://nuxtseo.com/docs/ai-ready/getting-started/introduction)

Search…```k`` /`

v5.0.9

- Playgrounds
- [Discord Support](https://discord.com/invite/275MBUBvgP)

### Getting Started

- [Introduction](https://nuxtseo.com/docs/link-checker/getting-started/introduction)
- [Installation](https://nuxtseo.com/docs/link-checker/getting-started/installation)
- [Troubleshooting](https://nuxtseo.com/docs/link-checker/getting-started/troubleshooting)

### Core Concepts

- [Inspection Rules](https://nuxtseo.com/docs/link-checker/guides/rules)
- [Link Checker DevTools](https://nuxtseo.com/docs/link-checker/guides/live-inspections)
- [Checking Links on Build](https://nuxtseo.com/docs/link-checker/guides/build-scans)
- [Exclude Links](https://nuxtseo.com/docs/link-checker/guides/exclude-links)
- [Exclude Pages](https://nuxtseo.com/docs/link-checker/guides/exclude-pages)
- [Generate Reports](https://nuxtseo.com/docs/link-checker/guides/generating-reports)
- [ESLint Integration](https://nuxtseo.com/docs/link-checker/guides/eslint)

Core Concepts

# Generate Reports

[Copy for LLMs](https://nuxtseo.com/docs/link-checker/guides/generating-reports.md)

## [Introduction](#introduction)

The Nuxt Link Checker module can generate reports of the broken links in your application. This is useful for CI environments where you want to see the results of the link checker without having to run it in your local environment.

## [Generating Reports](#generating-reports)

The module supports three report formats: `html`, `markdown` and `json`.

- `html`: a human readable report that can be opened in your browser.
- `markdown`: can be consumed by LLMs tools or embedded within [GitHub](https://github.com) pull requests.
- `json`: a machine readable report you can consume in your CI

To generate them, you can provide the `report` option:

```
export default defineNuxtConfig({
  linkChecker: {
    report: {
      // pick and choose which reports you want to generate
      html: true,
      markdown: true,
      json: true,
    }
  },
})
```

The reports will be output in the following paths:

- `html`: `.output/link-checker-report.html`
- `markdown`: `.output/link-checker-report.md`
- `json`: `.output/link-checker-report.json`

## [Publishing Public Reports](#publishing-public-reports)

Keeping your links healthy can be a lot of effort and be frustrating when you you are blocked in your CI pipeline due to them.

For this reason, you may want to publish your link checker reports as publicly accessible files after your deployment. These will be non-indexable but directly accessible by anyone.

You can make your link checker reports accessible after deployment by using the publish flag:

nuxt.config.ts

```
export default defineNuxtConfig({
  linkChecker: {
    report: {
      publish: true
    }
  },
})
```

When the publish flag is set to true, the reports will be:

1. Generated during the build process
2. Copied to your public directory
3. Available at the following paths once deployed:
  - HTML report: [https://nuxtseo.com/**link-checker**/link-checker-report.html](https://nuxtseo.com/__link-checker__/link-checker-report.html)
  - Markdown report: [https://nuxtseo.com/**link-checker**/link-checker-report.md](https://nuxtseo.com/__link-checker__/link-checker-report.md)
  - JSON report: [https://nuxtseo.com/**link-checker**/link-checker-report.json](https://nuxtseo.com/__link-checker__/link-checker-report.json)

[](https://nuxtseo.com/tools/xml-sitemap-validator)**Cross-reference with sitemap** - Use our [XML Sitemap Validator](https://nuxtseo.com/tools/xml-sitemap-validator) to ensure broken links aren't in your sitemap.

[Edit this page](https://github.com/harlan-zw/nuxt-link-checker/edit/main/docs/content/2.guides/4.generating-reports.md)

[Markdown For LLMs](https://nuxtseo.com/docs/link-checker/guides/generating-reports.md)

Did this page help you?

[Exclude Pages Exclude entire pages from link checking.](https://nuxtseo.com/docs/link-checker/guides/exclude-pages) [ESLint Integration Validate links in your editor with ESLint rules that check against your app's routes and sitemap.](https://nuxtseo.com/docs/link-checker/guides/eslint)

On this page

- [Introduction](#introduction)
- [Generating Reports](#generating-reports)
- [Publishing Public Reports](#publishing-public-reports)

[GitHub](https://github.com/harlan-zw/nuxt-seo) [ Discord](https://discord.com/invite/275MBUBvgP)

### [NuxtSEO](https://nuxtseo.com/ "Home")

- [Getting Started](https://nuxtseo.com/docs/nuxt-seo/getting-started/introduction)
- [MCP](https://nuxtseo.com/docs/nuxt-seo/guides/mcp)

Modules

- [Robots](https://nuxtseo.com/docs/robots/getting-started/introduction)
- [Sitemap](https://nuxtseo.com/docs/sitemap/getting-started/introduction)
- [OG Image](https://nuxtseo.com/docs/og-image/getting-started/introduction)
- [Schema.org](https://nuxtseo.com/docs/schema-org/getting-started/introduction)
- [Link Checker](https://nuxtseo.com/docs/link-checker/getting-started/introduction)
- [SEO Utils](https://nuxtseo.com/docs/seo-utils/getting-started/introduction)
- [Site Config](https://nuxtseo.com/docs/site-config/getting-started/introduction)
- [Skew Protection](https://nuxtseo.com/docs/skew-protection/getting-started/introduction)
- [AI Ready](https://nuxtseo.com/docs/ai-ready/getting-started/introduction)

### [NuxtSEO Pro](https://nuxtseo.com/pro "Nuxt SEO Pro")

- [Getting Started](https://nuxtseo.com/pro)
- [Dashboard](https://nuxtseo.com/pro/dashboard)
- [Pro MCP](https://nuxtseo.com/pro/docs/getting-started/mcp-setup)

### [Learn SEO](https://nuxtseo.com/learn-seo "Learn SEO")

Nuxt

- [Mastering Meta](https://nuxtseo.com/learn-seo/nuxt/mastering-meta)
- [Controlling Crawlers](https://nuxtseo.com/learn-seo/nuxt/controlling-crawlers)
- [Launch & Listen](https://nuxtseo.com/learn-seo/nuxt/launch-and-listen)
- [Routes & Rendering](https://nuxtseo.com/learn-seo/nuxt/routes-and-rendering)
- [Staying Secure](https://nuxtseo.com/learn-seo/nuxt/routes-and-rendering/security)

Vue

- [Vue SEO Guide](https://nuxtseo.com/learn-seo/vue)
- [Mastering Meta](https://nuxtseo.com/learn-seo/vue/mastering-meta)
- [Controlling Crawlers](https://nuxtseo.com/learn-seo/vue/controlling-crawlers)
- [SPA SEO](https://nuxtseo.com/learn-seo/vue/spa)
- [SSR Frameworks](https://nuxtseo.com/learn-seo/vue/ssr-frameworks)
- [SEO Checklist](https://nuxtseo.com/learn-seo/checklist)
- [Pre-Launch Warmup](https://nuxtseo.com/learn-seo/pre-launch-warmup)
- [Backlinks & Authority](https://nuxtseo.com/learn-seo/backlinks)

### [Tools](https://nuxtseo.com/tools "SEO Tools")

- [Social Share Debugger](https://nuxtseo.com/tools/social-share-debugger)
- [Robots.txt Generator](https://nuxtseo.com/tools/robots-txt-generator)
- [Meta Tag Checker](https://nuxtseo.com/tools/meta-tag-checker)
- [HTML to Markdown](https://nuxtseo.com/tools/html-to-markdown)
- [XML Sitemap Validator](https://nuxtseo.com/tools/xml-sitemap-validator)
- [Schema.org Validator](https://nuxtseo.com/tools/schema-validator)
- [Keyword Idea Generator](https://nuxtseo.com/tools/keyword-generator)
- [Keyword Research](https://nuxtseo.com/tools/keyword-research)
- [SERP Analyzer](https://nuxtseo.com/tools/serp-analyzer)
- [Domain Rankings](https://nuxtseo.com/tools/domain-rankings)

Copyright © 2023-2026 Harlan Wilton - [MIT License](https://github.com/harlan-zw/nuxt-seo/blob/main/license) · [mdream](https://mdream.dev)