Docs

Getting Started

Spin up the Sigma SEO Next.js app locally and understand how docs are authored in MDX.

Prerequisites

Make sure you have Node.js 18 or later and pnpm or npm installed before you continue.

Sigma SEO documentation lives alongside the application code inside src/content/docs. Every file in this directory is a first-class page rendered through our MDX pipeline.

Local Setup

Clone the repository and install dependencies with npm install or pnpm install.
Copy .env.example to .env and fill in the required values.
Start the development server with npm run dev.

Your docs changes hot reload together with other application code, so you can preview everything instantly.

Writing MDX

MDX lets you mix standard Markdown with React-powered components. Our setup automatically injects Shadcn UI components, so you can use them directly:

<Alert>
  <AlertTitle>Heads up!</AlertTitle>
  <AlertDescription>
    You can drop in buttons, badges, and any other shared component.
  </AlertDescription>
</Alert>

Reusable Components

When you need to create nested docs, just add directories. Slugs are inferred from the path, or you can override them by declaring a slug array in the front matter:

slug

slug:
  - guides
  - auditing

What’s Next

Add more pages under src/content/docs.
Provide front matter for titles, descriptions, and ordering.
Submit a PR — our build system pre-renders every doc so the /docs area is fast and searchable.