A framework for building documentation websites with React.js, supporting Next.js, Astro, and Vite-based React frameworks.
13.4K745TypeScriptMITUpdated 2 days ago
shuding/nextra
A Next.js-based framework for building documentation and content sites from MDX and Markdown files.
- Stars
- 13,941
- Forks
- 1,412
- Open issues
- 329
- Last commit
- 3 months ago
What is it?
Nextra is a static site generation framework built on Next.js. It lets you write pages in MDX or Markdown and turn them into a website, keeping the familiar Next.js routing, React components and build tooling.
The project ships as two packages: the core `nextra` package that handles content processing, and `nextra-theme-docs`, a documentation theme. The repository also includes examples and a documentation site, and is developed as a PNPM workspace managed with Turborepo.
Because it sits on Next.js, you can embed React components directly inside Markdown content and use the same deployment options as any Next.js app.
Key features
- 01Write pages in MDX or Markdown with embedded React components.
- 02Built on Next.js routing and build tooling.
- 03Provides a documentation theme package, nextra-theme-docs.
- 04Monorepo layout using PNPM workspaces and Turborepo.
Use cases
- Building a product or project documentation site.
- Publishing a technical blog or knowledge base from Markdown files.
- Creating interactive docs that combine prose with React components.
Quick start
- 1
Enable Corepack
corepack enable - 2
Install the project's dependencies
pnpm install - 3
Start the example docs site in dev mode
pnpm --filter example-docs dev
Things to know
- Development setup requires pnpm and Corepack, so it is aimed at contributors rather than quick end-user use.
- Documentation for using the framework is hosted externally at nextra.site.
Topics
FAQ
- What is nextra?
- A Next.js-based framework for building documentation and content sites from MDX and Markdown files. Nextra is a static site generation framework built on Next.js. It lets you write pages in MDX or Markdown and turn them into a website, keeping the familiar Next.js routing, React components and build tooling.
- Is nextra free to use? What license does it have?
- nextra is open source under the MIT license. Check the license terms before using it in commercial products.
- Is nextra still maintained?
- Updated within 6 months. The last commit to nextra was on Jul 31, 2026.
- What can I use nextra for?
- Building a product or project documentation site. Publishing a technical blog or knowledge base from Markdown files. Creating interactive docs that combine prose with React components.
- How do I install nextra?
- Enable Corepack: corepack enable Install the project's dependencies: pnpm install Start the example docs site in dev mode: pnpm --filter example-docs dev
- Where can I get nextra?
- The source code and installation instructions are on GitHub: https://github.com/shuding/nextra
Summary generated by AI from the project's README. GitHub stats refresh daily.
Related projects
A scaffolder that generates an editable Astro documentation site into your repo, with agent-readable Markdown and llms.txt output built in.
1.4K52TypeScriptMITUpdated 3 days ago
A Vue- and Vite-powered static site generator for building documentation and content sites from Markdown.
18.4K2.8KTypeScriptMITUpdated 3 days ago
A Next.js blog template that renders MDX posts with Tailwind CSS and TypeScript, ready to deploy on Vercel.
7.6K1.4KTypeScriptNo licenseUpdated last month
A React-based static site generator for building, deploying and maintaining open source project documentation websites.
66.5K10.1KTypeScriptMITUpdated 5 days ago
A Rust-based static site generator for Markdown documentation, from the team behind Material for MkDocs.
6K134RustMITUpdated 3 days ago