Skip to content

daustinn/slugtree

Repository files navigation

slugtree 🌳

Write in MDX. Let Slugtree build the tree.

Slugtree is a content layer that reads your MDX files and turns them into a strongly-typed navigation tree — with sidebar data, breadcrumbs, pagination, table of contents, and full-text search, ready to use. You own the UI, Slugtree owns the data.

🚀 Features

  • Next.js Native: Built specifically for the Next.js App Router (v14+).
  • Strongly Typed: Full TypeScript support with generated types based on your actual content.
  • Automatic Organization: Generates breadcrumbs, pagination, and TOC automatically.
  • Fast: Powered by Turbo, cached at build time, and optimized for SSG.

📦 Installation

pnpm add slugtree

(Note: Requires Next.js 14 or higher)

📖 Documentation

For full installation guides, API reference, and examples, visit our official documentation:

👉 slugtree.daustinn.com

📄 License

MIT © Daustinn

About

Write in MDX. Let Slugtree build the tree.

Topics

Resources

Stars

Watchers

Forks

Packages

 
 
 

Contributors