{"slug": "show-hn-reallysimpledocs-modern-ai-ready-documentation-site-with-astro", "title": "Show HN: ReallySimpleDocs – Modern, AI-ready documentation site with Astro", "summary": "Developer Hunvreus released ReallySimpleDocs, an open-source documentation integration for Astro that generates static docs routes from Markdown and MDX files and emits llms.txt, llms-full.txt and per-page Markdown exports for AI consumption. Version 1.1 requires Astro 7.4.13 or newer within version 7, Node.js 22.23.4 or newer, Basecoat 1.2.1 or newer within version 1, and Tailwind CSS 4.3 or newer within version 4, and drops Astro 6 support. The package adds Lunr search with a command dialog, sidebar navigation driven by docs/docs.json, and component slots for head content, sidebar chrome and header controls.", "body_md": "A simple documentation system for Astro, built with Basecoat and Tailwind CSS.\n\nReallySimpleDocs keeps docs portable: content lives in `docs/`, navigation lives in `docs/docs.json`, and the Astro integration owns the docs UI, search, Markdown exports, and LLM files.\n\nRequires Astro 7.4.13 or newer within version 7, Node.js 22.23.4 or newer, Basecoat 1.2.1 or newer within version 1, and Tailwind CSS 4.3 or newer within version 4. Version 1.1 drops Astro 6 support.\n\nAdd ReallySimpleDocs to an Astro site:\n\n```\nnpm install reallysimpledocs basecoat-css tailwindcss\n```\n\nConfigure the integration:\n\n``` python\n// astro.config.mjs\nimport { defineConfig } from \"astro/config\";\nimport reallySimpleDocs from \"reallysimpledocs/astro\";\n\nexport default defineConfig({\n  integrations: [\n    reallySimpleDocs({\n      docsDir: \"./docs\",\n      routeBase: \"/docs\",\n      style: \"nova\",\n      site: {\n        title: \"Acme Docs\",\n        description: \"Documentation for Acme.\",\n        url: \"https://docs.example.com\",\n        favicon: \"favicon.svg\",\n        socialImage: \"social.png\",\n      },\n    }),\n  ],\n});\n```\n\nCreate your first docs page:\n\n```\ndocs/\n├── docs.json\n└── index.md\n{\n  \"menu\": [\n    {\n      \"type\": \"group\",\n      \"label\": \"Docs\",\n      \"items\": [{ \"slug\": \"index\", \"icon\": \"info\" }]\n    }\n  ]\n}\n# Introduction\n\nWelcome to the docs.\n```\n\n- Static docs routes from Markdown and MDX files.\n- Sidebar navigation from `docs/docs.json` .\n- Lunr search with a built-in command dialog.\n- Syntax-highlighted code blocks with copy buttons.\n- `llms.txt` ,`llms-full.txt` , and per-page Markdown exports.\n- Basecoat styling with style-specific RSD CSS for docs surfaces.\n- Component slots for additive head content, sidebar chrome, and header controls.\n\nUse `components.ContentHeader` for controls between search and the built-in theme toggle:\n\n```\nreallySimpleDocs({\n  components: {\n    ContentHeader: \"./src/components/ContentHeader.astro\",\n  },\n});\n```\n\nUse `components.Head` to add tags to `<head>`. RSD's built-in metadata, theme setup, Basecoat JavaScript (including code copying), and search behavior still render.\n\nUse `customCss` for project CSS imported after Basecoat and RSD styles:\n\n```\nreallySimpleDocs({\n  style: \"nova\",\n  customCss: [\"./src/docs.css\"],\n});\n```\n\nUse `css: false` only when you provide the full Tailwind/Basecoat/RSD stylesheet pipeline yourself. RSD exports its own CSS for that case:\n\n```\n@import \"reallysimpledocs/css\";\n```\n\nRender the exported `CommandDialog` on any Astro page where you want docs search:\n\n``` js\n---\nimport { CommandDialog } from \"reallysimpledocs/components\";\n---\n\n<CommandDialog />\n\n<button type=\"button\" class=\"btn\" onclick=\"window.rsdOpenCommandSearch?.()\">\n  Search docs\n</button>\nnpm install\nnpm run dev\n```\n\nRun the checks before opening a pull request:\n\n```\nnpm run check\n```\n\nIt builds the site, checks the built output (`scripts/assert-site-output.mjs`), then packs the package and builds a throwaway consumer app from the tarball (`npm run smoke:consumer`). CI runs the same command on every pull request and push to `main`. Use `npm pack --dry-run` to see which files would be published.\n\nGo to [reallysimpledocs.com](https://reallysimpledocs.com).\n\nSee [CHANGELOG.md](https://github.com/hunvreus/reallysimpledocs/blob/main/CHANGELOG.md) for release notes and upgrade requirements.\n\nSee [the release workflow in CONTRIBUTING.md](https://github.com/hunvreus/reallysimpledocs/blob/main/CONTRIBUTING.md#releases-and-the-docs-site) for staged npm publishing and docs deployment.", "url": "https://wpnews.pro/news/show-hn-reallysimpledocs-modern-ai-ready-documentation-site-with-astro", "canonical_source": "https://github.com/hunvreus/reallysimpledocs", "published_at": "2026-11-22 13:58:23+00:00", "updated_at": "2026-11-22 14:12:09.069212+00:00", "lang": "en", "topics": ["ai-crawlers", "developer-tools", "ai-tools"], "entities": ["ReallySimpleDocs", "Astro", "Basecoat", "Tailwind CSS", "Node.js", "Lunr", "Hunvreus"], "also_reported_by": [], "takeaway": "ReallySimpleDocs 1.1 generates llms.txt, llms-full.txt and per-page Markdown exports from docs/ Markdown, but requires Astro 7.4.13+, Node.js 22.23.4+, Basecoat 1.2.1+ and Tailwind CSS 4.3+, and drops Astro 6 support.", "recommendation": null, "alternates": {"html": "https://wpnews.pro/news/show-hn-reallysimpledocs-modern-ai-ready-documentation-site-with-astro", "markdown": "https://wpnews.pro/news/show-hn-reallysimpledocs-modern-ai-ready-documentation-site-with-astro.md", "text": "https://wpnews.pro/news/show-hn-reallysimpledocs-modern-ai-ready-documentation-site-with-astro.txt", "jsonld": "https://wpnews.pro/news/show-hn-reallysimpledocs-modern-ai-ready-documentation-site-with-astro.jsonld"}}