nextra README

The project's README from github.com/shuding/nextra. As one markdown file: 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

pnpm --filter nextra build

Watch mode: pnpm --filter nextra dev

Build nextra-theme-docs

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

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

Inkeep - AI Agents that get real work done xyflow preview

nextra (shuding/nextra)

Searching Database…

13.9K ·GitHub
What is this?Nextra is a simple, powerful and flexible site generation framework with everything you love from Next.js: you write content in Markdown/MDX and it turns it into a website, typically documentation or a blog.
Is this a hosted service, or something I add to my own project?It is a framework you build with, not a service: the repo is organized as a core package plus separate themes (for example a docs theme), so you compose your own Next.js-based site.
How do I get started with it?The README links to the documentation for usage; to develop Nextra itself you enable Corepack and then run pnpm install in the repo.
What do I need installed before it will run?A Node.js environment: the project builds with pnpm (provided via Corepack) inside PNPM Workspaces, with Turborepo driving the builds.
Any pitfalls when customizing it?If you update the core or theme packages, a rebuild is required — or keep watch mode running for both Nextra and the theme in separate terminals.
Where does the resulting site run?It produces a website: a Next.js site that you deploy and host on the web like any other site.
Does it come with ready-made themes?The repo develops a docs theme (nextra-theme-docs) and keeps example sites for docs, blog and an i18n setup (swr-site); you can run them locally via pnpm scripts like dev:theme-docs.
Can I preview content changes while writing?Yes — in the local example setup, any change to example/docs is re-rendered instantly; core or theme changes need a rebuild or watch mode.
Is this an established project?Yes: it dates back to June 2020, has around 13.9k GitHub stars, is not archived, and runs CI workflows for lint, tests and releases.
What are similar projects?docusaurus, NotionNext, fumadocs, docs, hexo, next.js, umi, astro
Creator
shuding
Size
40 MB
Stars
13.9K
Age
6y
Commits · 90 Days