Skip to main content
Linkspector Logo

​
What is Linkspector?

Linkspector is a powerful CLI tool that checks for broken hyperlinks in your documentation and content files. It supports Markdown and AsciiDoc files, with ReStructured Text support coming soon, making it an essential tool for maintaining high-quality documentation.

​
Why Linkspector?

Unlike traditional link checkers, Linkspector uses Puppeteer to check links in Chrome’s headless mode, significantly reducing false positives. This approach ensures more accurate results and helps you maintain reliable documentation.

Enhanced Accuracy

Puppeteer-powered checking reduces false positives by testing links in a real browser environment

Multi-Format Support

Check links in Markdown and AsciiDoc files (ReStructured Text coming soon)

CI/CD Ready

Designed for seamless integration into your development workflow with JSON output and GitHub Actions

Highly Configurable

Flexible configuration options for ignoring patterns, custom headers, and redirect handling

​
Key Features

  • Puppeteer Integration: Check links using Chrome’s headless browser for accurate validation
  • Multiple Markup Formats: Support for Markdown and AsciiDoc (ReStructured Text coming soon)
  • Flexible Configuration: Customize behavior with .linkspector.yml configuration file
  • CI/CD Integration: Output results in RDJSON format for use with reviewdog and other tools
  • Advanced Filtering: Ignore specific URL patterns and apply replacement rules
  • HTTP Customization: Set custom headers and control redirect behavior
  • GitHub Actions: Native integration with GitHub Actions workflow

​
Quick Example

# Install globally
npm install -g @umbrelladocs/linkspector

# Check links in your documentation
linkspector check

# Check with custom configuration
linkspector check -c custom-config.yml

# Output results in JSON format
linkspector check -j

​
Get Started

Installation

Install Linkspector via npm or download the binary

Quickstart

Get up and running in minutes with a simple example

Configuration

Learn how to configure Linkspector for your project

GitHub Actions

Integrate Linkspector into your CI/CD pipeline

​
Community and Support

Linkspector is an open-source project licensed under Apache-2.0. Contributions are welcome!

Contribute to Linkspector

Learn how to contribute to the project

Build docs developers (and LLMs) love

Get started for freeTalk to us