Getting started

Introduction

What ranklint is, which packages exist and how they fit together.

ranklint is an SEO toolkit for Nuxt 4 and a stack-agnostic SEO linter for CI.

Runtime — the @ranklint/nuxt module serves sitemap.xml, robots.txt and typed JSON-LD.
Dev — an "SEO" tab in Nuxt DevTools: heading outline, meta, JSON-LD with validation, page audit.
CI — ranklint audit crawls a deployed site with Playwright and fails on thresholds; markdown, json, junit, html, gitlab, github and sarif reporters.

Packages

Package	Purpose
`@ranklint/nuxt`	Nuxt 4 module: sitemap, robots, useJsonLd, DevTools tab
`@ranklint/cli`	`ranklint audit` — crawler (Playwright) + checks + reports
`@ranklint/core`	Engine: crawler, runner, config (no Nuxt dependencies)
`@ranklint/checks`	43 rules + Schema.org schemas
`@ranklint/reporters`	markdown / junit / json / html / gitlab / github / sarif
`@ranklint/devtools`	Vue panel for Nuxt DevTools
`@ranklint/preset-default`	Preset with the built-in rules for `extends`
`ranklint`	Alias of `@ranklint/cli` — `npm i -D ranklint` gives the `ranklint` binary

Requirements: Nuxt ^4.0.0, Node.js >= 20. MIT license.

Installation

Install the Nuxt module and the CLI, and run the first audit.