RenderShield Quickstart

Install RenderShield, initialize content, build deterministic crawler HTML, then verify that production bot traffic receives that output.

1. Prerequisites

Use Node.js 18+ (the package engines.node requirement is >=18).

2. Install

npm i -D @lownoise-studio/rendershield

3. Init

npx rendershield init

Add markdown content under your configured content path (for example content/docs/*.md).

4. Build

npx rendershield build

This generates static crawler HTML for configured routes.

5. Local verify

npx rendershield verify

6. Production verify

npx rendershield verify --prod https://rendershield.dev/docs/quickstart

Replace the URL with your own production route.

Edge note: crawlers that match Worker bot rules receive prerendered HTML (x-rendershield: bot-hit), while normal browsers keep the SPA path (x-rendershield: pass-through).

npm package
GitHub repository