中文文档
入门

文档主题

Nextra 的文档主题是一款包含几乎所有构建现代文档网站所需内容的主题。 它包括顶部导航栏、搜索栏、 页面侧边栏、TOC 侧边栏以及其他内置组件。

本网站就是使用 Nextra 文档主题构建的。

从模板快速入门

部署到 Vercel

您可以先创建自己的 Nextra 网站,然后点击链接 部署到 Vercel:

Vercel 将 fork Nextra 文档模板仓库 (opens in a new tab) 并 为你部署网站。部署完成后,后续源码仓库中的每一个 commit 将被 自动部署。

Fork 文档模板仓库

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

创建一个新项目

安装

要手动创建一个 Nextra 文档网站的话,则必须安装 Next.jsReactNextra 以及 Nextra 文档主题。进入你的项目目录并运行 以下命令来安装这些依赖项:

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

如果你的项目中已经安装了 Next.js,则只需 安装 nextranextra-theme-docs 即可。

然后在 package.json 文件的 scripts 配置项中添加以下配置即可:

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

你可以使用 npm run dev (在开发模式下运行)命令或 npm run build && npm run start(在生产模式下运行)命令启动服务器 (这里假设你使用的是 npm)。

💡

如果你还不熟悉 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'
  }
  // ... other theme options
}

该主题的完整配置请看 这里

准备出发!

现在,你可以创建你的第一个 MDX 页面了 pages/index.mdx

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

然后运行 nextnext dev 命令(这两个命令在前面已经配置到 package.json 文件中了)开启你的 开发之旅吧! 🎉

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