preview

Build and serve a local Docusaurus site, then screenshot pages and crawl internal links.

1|Updated Jul 17, 2025
One-click install
npx skills add https://github.com/whatsper/texterdocs --skill preview-whatsper
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: preview
Source: https://github.com/whatsper/texterdocs/tree/main/.claude/skills/preview
Command: npx skills add https://github.com/whatsper/texterdocs --skill preview-whatsper

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Verifies that a Docusaurus site renders correctly after changes by automatically building, serving locally, and performing visual and link checks to catch regressions.

Core Features & Use Cases

  • Build and serve the Docusaurus site locally to validate rendering.
  • Screenshot key pages in light mode and crawl internal links to identify broken or misrouted links.
  • Provide a structured workflow to validate edits to docs, components, or CSS against the live site.

Quick Start

Build and serve the Docusaurus site, then screenshot key pages and run the link crawl to verify rendering.

Frequently Asked Questions about preview

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I automate Docusaurus visual regression testing and link checks?

You can automate Docusaurus visual regression testing by building the site locally, serving it, taking light-mode screenshots of key pages, and crawling internal links to identify broken routes.

How does Docusaurus broken link detection work during local builds?

Docusaurus broken link detection works by configuring onBrokenLinks to 'throw' during a local build, which fails the build process immediately when an internal link crawl encounters a misrouted or missing page.

Can I validate Docusaurus CSS and component edits against a live local server?

Yes, you can validate Docusaurus CSS and component edits by building and serving the site locally, then running a screenshot pass to verify visual rendering accuracy across predefined pages.

What is the best way to crawl internal links on a Docusaurus site to find broken routes?

The best way to crawl internal links on a Docusaurus site is to serve the local build under a specific path like /texterdocs and run an automated link crawl pass across a predefined page set.

Does the Docusaurus preview workflow support light mode screenshots?

Yes, the Docusaurus preview workflow supports light mode screenshots by running an automated screenshot pass after building and serving the site locally to verify visual accuracy.

Why does my Docusaurus build throw an error when a link is broken?

Your Docusaurus build throws an error when a link is broken because the onBrokenLinks setting is configured to 'throw', halting the build to prevent deploying a site with misrouted internal links.