# Quickstart

## Install

> **Prerequisite**
> ReallySimpleDocs is an Astro integration. Add it to an existing Astro site, or create one first with `npm create astro@latest`.

<Steps>
  <Step title="Install packages">

<CodeGroup>
```bash title="npm"
npm install reallysimpledocs basecoat-css@beta tailwindcss
```

```bash title="pnpm"
pnpm add reallysimpledocs basecoat-css@beta tailwindcss
```

```bash title="yarn"
yarn add reallysimpledocs basecoat-css@beta tailwindcss
```

```bash title="bun"
bun add reallysimpledocs basecoat-css@beta tailwindcss
```
</CodeGroup>

  </Step>
  <Step title="Add the Astro integration">

```js title="astro.config.mjs"
import { defineConfig } from "astro/config";
import reallySimpleDocs from "reallysimpledocs/astro";

export default defineConfig({
  integrations: [
    reallySimpleDocs({
      site: {
        title: "Acme Docs",
      },
    }),
  ],
});
```

  </Step>
  <Step title="Create docs">
<CodeGroup>
```md title="docs/index.md"
# Introduction

Welcome to the docs.
```

```json title="docs/docs.json"
{
  "menu": [
    {
      "type": "group",
      "label": "Docs",
      "items": [{ "slug": "index", "icon": "info" }]
    }
  ]
}
```
</CodeGroup>
  </Step>
  <Step title="Run Astro">

```bash
npm run dev
```

  </Step>
</Steps>

## Usage

Start adding Markdown and MDX files to the `docs/` folder:

```text
docs/
├── docs.json    # Sidebar navigation
├── index.md     # First page
└── guide.mdx    # Optional component-rich page
```

Use `docs/docs.json` to manage [navigation](/navigation/). Add Markdown and MDX files as [pages](/pages/).

Use `.mdx` only when a page needs richer [components](/components): `Callout`, `Code`, `CodeGroup`, `Preview`, `Tabs`, `Steps`, `Card`, or `CardGrid`.

ReallySimpleDocs also wires up

- [Basecoat](https://basecoatui.com) and Tailwind CSS for styling,
- syntax highlighting for fenced code blocks with copy buttons,
- full text search using [Lunr](https://lunrjs.com/),
- `llms.txt` and `llms-full.txt` files for agents,
- Markdown export and AI links for each page.

For themes, custom CSS, assets, and component overrides, see [Customization](/customization/).

## Update

Update ReallySimpleDocs and its peer packages together:

<CodeGroup>
```bash title="npm"
npm install reallysimpledocs basecoat-css@beta tailwindcss
```

```bash title="pnpm"
pnpm add reallysimpledocs basecoat-css@beta tailwindcss
```

```bash title="yarn"
yarn add reallysimpledocs basecoat-css@beta tailwindcss
```

```bash title="bun"
bun add reallysimpledocs basecoat-css@beta tailwindcss
```
</CodeGroup>

Then rebuild:

```bash
npm run build
```

Your content stays in `docs/`; updates should mostly affect the package and your Astro config.