GitHub GitHub GitHub

Quickstart

Introduction
Navigation

Quickstart

Install

Prerequisite

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

Install packages

npm install reallysimpledocs basecoat-css@beta tailwindcss

Add the Astro integration

astro.config.mjs
import { defineConfig } from "astro/config";
import reallySimpleDocs from "reallysimpledocs/astro";

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

Create docs

# Introduction

Welcome to the docs.

Run Astro

npm run dev

Usage

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

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

Use docs/docs.json to manage navigation. Add Markdown and MDX files as pages.

Use .mdx only when a page needs richer components: Callout, Code, CodeGroup, Preview, Tabs, Steps, Card, or CardGrid.

ReallySimpleDocs also wires up

  • Basecoat and Tailwind CSS for styling,
  • syntax highlighting for fenced code blocks with copy buttons,
  • full text search using Lunr,
  • 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.

Update

Update ReallySimpleDocs and its peer packages together:

npm install reallysimpledocs basecoat-css@beta tailwindcss

Then rebuild:

npm run build

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