Skip to content

Releases: RapierCraft/Scribe

v1.0.0 — Initial Release

21 Mar 09:02

Choose a tag to compare

Scribe v1.0.0

The open-source docs framework for Next.js. A free alternative to Mintlify.

What's included

Layout

  • 3-column responsive docs layout (sidebar / content / table of contents)
  • Sticky top navigation bar with version switcher
  • Mobile-responsive with slide-out sidebar
  • Embedded mode (?embedded=true)

Components

  • Callout — info, warning, success, danger, tip
  • CodeBlock — syntax highlighting for 30+ languages, copy button, line highlighting
  • CodeTabs — multi-language tabbed code examples
  • ApiEndpoint — REST endpoint docs with method badges, parameter tables, request/response examples
  • Steps — numbered step sequences with optional code
  • Card + CardGrid — navigation cards with icons and hover effects

Navigation

  • Sidebar — collapsible groups, badges, active link tracking
  • Search — full-text fuzzy search with keyboard navigation
  • Table of Contents — IntersectionObserver-based scroll tracking
  • Version Switcher — API version dropdown

Developer Experience

  • Single scribe.config.ts controls everything
  • shadcn/ui CSS variable compatible
  • Dark/light mode with system detection
  • MDX support with pre-styled components
  • Next.js App Router native (Server Components)

Quick Start

```bash
git clone https://github.com/RapierCraft/Scribe.git my-docs
cd my-docs && npm install && npm run dev
```

License

MIT