Nextra 中文文档
快速开始

文档主题

Nextra 文档主题几乎包含了构建现代文档网站所需的一切。它包括顶部导航栏、搜索栏、页面侧边栏、目录侧边栏和其他内置组件。

这个网站本身就是用Nextra文档主题构建的。

从模板快速开始

部署到Vercel

您可以通过点击链接创建您自己的Nextra网站并部署到Vercel开始:

Vercel将 fork Nextra Docs模板 (opens in a new tab) 并为您部署站点。一旦完成,存储库中的每个提交都将自动部署。

Fork模板

您也可以手动 fork Nextra Docs模板 (opens in a new tab)

作为新项目开始

安装

要手动创建一个Nextra文档站点,您必须安装Next.jsReactNextraNextra文档主题。在您的项目目录中,运行以下命令来安装依赖项:

npm i next react react-dom nextra nextra-theme-docs
💡

如果您的项目中已经安装了 Next.js,则只需要安装 nextranextra-theme-docs 作为附加组件。

package.json 中添加以下脚本:

package.json
"scripts": {
  "dev": "next",
  "build": "next build",
  "start": "next start"
},

您可以使用以下命令启动服务器,例如,如果您使用 npm,则是 npm run dev,这将在开发模式下运行,或者使用 npm run build && npm run start 进入生产模式。

💡

如果您不熟悉 Next.js,请注意开发模式下速度会显著较慢,因为 Next.js 会编译您访问的每个页面。

添加 Next.js 配置

在项目的根目录中创建以下 next.config.js 文件:

next.config.js
const withNextra = require('nextra')({
  theme: 'nextra-theme-docs',
  themeConfig: './theme.config.jsx'
})
 
module.exports = withNextra()
 
// 如果你有其他 Next.js 配置,你可以将它们作为参数传递:
// module.exports = withNextra({ /* other next.js config */ })

通过上述配置,Nextra 可以处理您 Next.js 项目中的 Markdown 文件, 并使用指定的主题。其他 Nextra 配置可以在指南中找到。

创建文档主题配置

最后,在项目的根目录中创建相应的 theme.config.jsx 文件。这将用于配置 Nextra 文档主题:

theme.config.jsx
export default {
  logo: <span>My Nextra Documentation</span>,
  project: {
    link: 'https://github.com/shuding/nextra'
  }
  // ... 其他设置
}

完整的主题设置可以查阅 这里.

准备就绪!

现在,您可以创建您的第一个 MDX 页面,命名为 pages/index.mdx

pages/index.mdx
# Welcome to Nextra
 
Hello, world!

然后,运行 package.json 中指定的 nextnext dev 命令来开始开发项目!🎉

接下来,请查看下一节,了解如何组织文档结构并配置网站主题: