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
Что это такое?Nextra — это простой, мощный и гибкий фреймворк для генерации сайтов, в котором есть всё то, что вы любите в Next.js: вы пишете контент на Markdown/MDX, а он превращает его в сайт — обычно документацию или блог.
Это хостинговый сервис или то, что я добавляю в свой проект?Это фреймворк, на котором вы строите сайт, а не сервис: репозиторий устроен как основой пакет плюс отдельные темы (например, тема для документации), так что вы собираете собственный сайт на базе Next.js.
С чего мне начать?В README есть ссылка на документацию по использованию; чтобы разрабатывать сам Nextra, включите Corepack и затем выполните pnpm install в репозитории.
Что должно быть установлено, чтобы это запустилось?Окружение Node.js: проект собирается с помощью pnpm (предоставляется через Corepack) внутри PNPM Workspaces, а сборками управляет Turborepo.
Есть ли подводные камни при доработке под себя?Если вы обновляете основные пакеты (core) или темы, нужна пересборка — либо держите включённым режим watch для Nextra и темы в отдельных терминалах.
Где будет работать получившийся сайт?На выходе получается веб-сайт: сайт на Next.js, который вы разворачиваете и хостите в интернете, как любой другой сайт.
Там есть готовые темы?В репозитории разрабатывается тема для документации (nextra-theme-docs) и хранятся примеры сайтов для документации, блога и настройки i18n (swr-site); их можно запустить локально через pnpm-скрипты вроде dev:theme-docs.
Могу ли я видеть изменения контента прямо во время написания?Да — в локальном примере любое изменение в example/docs мгновенно перерисовывается; изменения в core или теме требуют пересборки или режима watch.
Это давно существующий, проверенный проект?Да: он ведёт историю с июня 2020 года, у него около 13,9 тыс. звёзд на GitHub, он не переведён в архив, и по нему работают CI-воркфлоу для линта, тестов и релизов.
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