Repolode
shuding

shuding/nextra

基于 Next.js 的框架,用 MDX 和 Markdown 文件快速搭建文档与内容站点。

Star
13,941
Fork
1,412
未关闭 Issue
329
最近提交
3个月前

这是什么?

Nextra 是一个基于 Next.js 构建的静态站点生成框架。你可以用 MDX 或 Markdown 编写页面,并将其转换为网站,同时保留 Next.js 熟悉的路由、React 组件和构建工具。

项目由两个包组成:核心包 `nextra` 负责内容处理,`nextra-theme-docs` 则是文档主题。仓库中还包含示例项目和文档站点,使用 PNPM Workspaces 与 Turborepo 进行管理。

由于基于 Next.js,你可以在 Markdown 内容中直接嵌入 React 组件,并使用与普通 Next.js 应用相同的部署方式。

核心功能

  • 01使用 MDX 或 Markdown 编写页面,并可嵌入 React 组件。
  • 02基于 Next.js 的路由与构建工具。
  • 03提供文档主题包 nextra-theme-docs。
  • 04采用 PNPM Workspaces 与 Turborepo 的 monorepo 结构。

适用场景

  • 搭建产品或项目的文档站点。
  • 基于 Markdown 文件发布技术博客或知识库。
  • 制作将文字与 React 组件结合的交互式文档。

快速上手

  1. 1

    启用 Corepack

    corepack enable
  2. 2

    安装项目依赖

    pnpm install
  3. 3

    以开发模式启动示例文档站点

    pnpm --filter example-docs dev

使用前须知

  • 开发环境需要 pnpm 和 Corepack,更适合贡献者而非快速使用者。
  • 框架使用文档托管在外部站点 nextra.site。

标签

常见问题

nextra 是什么?
基于 Next.js 的框架,用 MDX 和 Markdown 文件快速搭建文档与内容站点。 Nextra 是一个基于 Next.js 构建的静态站点生成框架。你可以用 MDX 或 Markdown 编写页面,并将其转换为网站,同时保留 Next.js 熟悉的路由、React 组件和构建工具。
nextra 可以免费使用吗?用的什么许可证?
nextra 以 MIT 许可证开源。用于商业产品前,请先确认许可证条款。
nextra 还在维护吗?
半年内有更新。nextra 最近一次提交是在 2026年7月31日。
nextra 适合用来做什么?
搭建产品或项目的文档站点。 基于 Markdown 文件发布技术博客或知识库。 制作将文字与 React 组件结合的交互式文档。
nextra 怎么安装和运行?
启用 Corepack: corepack enable 安装项目依赖: pnpm install 以开发模式启动示例文档站点: pnpm --filter example-docs dev
在哪里获取 nextra?
源代码和安装说明在 GitHub 上:https://github.com/shuding/nextra

概要由 AI 根据项目 README 生成;GitHub 数据每日更新。

相关项目