Vibeleaderboard
Index / tool
Visit github.com
Category
Developer Tools
Rank
No. 1342Tools index
Pricing
Open Source
Type
TOOL
GitHub
78 stars
Latest release
1.3.0
Date

About

ReallySimpleDocs is an Astro integration for building documentation sites from Markdown and MDX files. Navigation is defined in a JSON file, and the integration provides sidebar, search, syntax-highlighted code blocks and exports of per-page Markdown and LLM-readable files. Styling uses Basecoat and Tailwind CSS, which keeps docs content portable and readable by AI tools.

What it does

You drop a package into an existing Astro site, write pages as plain text files in one folder, and list them in a single menu file. It then generates the whole reading experience: a sidebar, a keyboard-shortcut search box that runs in the browser, highlighted code samples with copy buttons, and a plain-text copy of every page plus an index file that coding agents can fetch instead of scraping HTML.

Why it's ranked here

A small, focused package with an honest scope. It is MIT licensed, ships its source directly with no compile step, and pins a narrow, explicit set of peer packages. The menu file is the single source of truth for which pages exist, and the agent-facing index is generated from that same menu, so the human sidebar and the machine-readable listing cannot drift apart. The release check builds a throwaway consumer site from the packed package, which tests what users actually install.

What's good

Search keeps code examples apart from prose when it builds its index, so a query for a concept is not drowned by matches inside code blocks. Pages are read only from inside the configured content folder; a menu entry pointing outside it raises an error rather than reading the file. A missing page fails the build with a message naming the expected file. Styling choices are layered: pick one of eight preset looks, add your own stylesheet on top, or swap in your own header, sidebar header and footer pieces without forking the layout.

Tradeoffs

It is tied tightly to one stack: Astro 7, Tailwind 4 and the Basecoat component kit are required peers, and turning off the managed styling means reproducing it yourself from the project's own components. Node 22 or newer is required. There is no built-in sitemap; the docs send you to Astro's separate integration. A page that is not listed in the menu file is not built at all. The package scripts carry build and smoke checks but no unit test runner.

How to use it well

Best for a team that already runs an Astro site on Tailwind and wants product docs next to the marketing pages, with an agent-readable copy for free. Keep the menu file as your table of contents and add a page there the moment you create it. Use the plain Markdown format by default and reach for the component format only for tabs, callouts or step lists. If you are not on Astro, or want a design system other than Basecoat, look elsewhere.

Technical notes+

The public entry src/index.js re-exports the Astro integration. In src/runtime/lib/docs.js, getPages reads the menu manifest via getManifest and walks it through flattenMenuSlugs, so the menu decides which pages exist; resolveDocFile tries .md then .mdx and throws on a miss, and getDocMarkdown rejects any resolved path whose relative form escapes docsDir. getSearchDocs feeds Lunr after splitFencedMarkdown strips fenced blocks into a separate code field. Rendering uses marked with Shiki highlighting and a custom heading renderer that collects h2 and h3 anchors. src/runtime/pages/llms.txt.ts emits a text/plain listing grouped by menu group, linking each page's markdownPath. package.json declares the npm check script as build, then an output assertion script, then a packed-tarball consumer smoke test.

Observed

License
MIT
Language
JavaScript (ES modules), with TypeScript route files
Packaging
npm package reallysimpledocs, published as source with no build step
Interface
Astro integration plus an exported search dialog component
Runtime requirement
Node.js 22 or newer
Peer packages
Astro 7, Basecoat 1, Tailwind CSS 4
Search
Client-side Lunr index, code indexed separately from prose
Agent output
An agent index file, a full-content bundle and a Markdown export per page
Sitemap
Not generated; docs point to Astro's sitemap integration
Test setup
package.json scripts run a build, an output check and a consumer smoke test; no unit test runner declared

Read from README.md, package.json, LICENSE.md, docs/quickstart.mdx, docs/customization.mdx, src/index.js, src/runtime/lib/docs.js, src/runtime/pages/llms.txt.ts.

Tags

astrodocumentationmarkdownmdxllms-txttailwind

Tech Stack

Node.js

Comments (0)

No comments yet

Editorially curated, with community endorsements as a secondary signal. Corrections welcome.