Welcome to your ReadMe docs 👋

This repo is the home for your ReadMe documentation. Everything here, including guides, API references, and custom pages, shows up on your docs site.

The easiest way to work on your docs locally is with the @readme/cli. Here are a few commands to get you started:

Lint your docs:

npx @readme/cli lint

Configure linting for every branch via GitHub Actions:

npx @readme/cli setup:github

Or view the full list. You can preview docs locally, validate your OAS specs, install AI skills and more:

npx @readme/cli --help

Want to learn more? Read about ReadMe or browse the @readme/cli on npm.

Navigation Menu