nextra

Simple, powerful and flexible site generation framework with everything you love from Next.js.

13,774 stars TypeScript Markdown Skills API Spec #markdown#mdx#nextjs#nextra
AI Prompts & Specs

Repository: shuding/nextra


Stars: 13737

README.md

Nextra

Simple, powerful and flexible site generation framework with everything you love
from Next.js.

Documentation

https://nextra.site

Development

Installation

The Nextra repository uses PNPM Workspaces and
Turborepo.

1. Run corepack enable to enable Corepack.

> If the command above fails, run npm install -g corepack@latest to install
> the latest version of
> Corepack.

2. Run pnpm install to install the project's dependencies.

Build nextra

bash
pnpm --filter nextra build

Watch mode: pnpm --filter nextra dev

Build nextra-theme-docs

bash
pnpm --filter nextra-theme-docs build

Development

You can also debug them together with a website locally. For instance, to start
examples/docs locally, run

bash
pnpm --filter example-docs dev

Any change to example/docs will be re-rendered instantly.

If you update the core or theme packages, a rebuild is required. Or you can use
the watch mode for both Nextra and the theme in separated terminals.

Sponsors

<div>
<a href="https://inkeep.com?utm_source=github&utm_campaign=nextra&utm_content=logolink">
<img src="/docs/app/showcase/_logos/inkeep.png" alt="Inkeep - AI Agents that get real work done" width="256">
</a>
<a href="https://xyflow.com?utm_source=github&utm_campaign=nextra&utm_content=logolink">
<img src="/docs/app/showcase/_logos/xyflow.png" alt="xyflow preview" width="256">
</a>
</div>