版本：3.8.1

创建页面

在本节中，我们将学习如何在 Docusaurus 中创建页面。

@docusaurus/plugin-content-pages 插件使你能够创建一次性的独立页面，例如展示页、演练场页或支持页。你可以使用 React 组件或 Markdown。

注意

页面没有侧边栏，只有文档有。

信息

查阅页面插件 API 参考文档以获取所有可用选项的完整列表。

添加 React 页面

React 被用作创建页面的 UI 库。每个页面组件都应导出一个 React 组件，你可以利用 React 的表达能力来构建丰富和交互式的内容。

创建一个文件 /src/pages/helloReact.js

/src/pages/helloReact.js
import React from 'react';
import Layout from '@theme/Layout';

export default function Hello() {
  return (
    <Layout title="Hello" description="Hello React Page">
      <div
        style={{
          display: 'flex',
          justifyContent: 'center',
          alignItems: 'center',
          height: '50vh',
          fontSize: '20px',
        }}>
        <p>
          Edit <code>pages/helloReact.js</code> and save to reload.
        </p>
      </div>
    </Layout>
  );
}

保存文件后，开发服务器将自动重新加载更改。现在打开 https://:3000/helloReact，你将看到刚刚创建的新页面。

每个页面本身不带任何样式。如果你希望导航栏和/或页脚出现，需要从 @theme/Layout 导入 Layout 组件，并将你的内容包裹在该组件内。

提示

你也可以使用 .tsx 扩展名创建 TypeScript 页面 (helloReact.tsx)。

添加 Markdown 页面

创建一个文件 /src/pages/helloMarkdown.md

/src/pages/helloMarkdown.md
---
title: my hello page title
description: my hello page description
hide_table_of_contents: true
---

# Hello

How are you?

同样，一个页面将在 https://:3000/helloMarkdown 创建。

Markdown 页面不如 React 页面灵活，因为它总是使用主题布局。

这里有一个Markdown 页面示例。

提示

你也可以在 Markdown 页面中使用 React 的全部功能，请参考 MDX 文档。

路由

如果你熟悉 Jekyll 和 Next 等其他静态网站生成器，这种路由方法会让你感到熟悉。你在 /src/pages/ 目录下创建的任何 JavaScript 文件都将自动转换为网站页面，遵循 /src/pages/ 目录结构。例如：

/src/pages/index.js → [baseUrl]
/src/pages/foo.js → [baseUrl]/foo
/src/pages/foo/test.js → [baseUrl]/foo/test
/src/pages/foo/index.js → [baseUrl]/foo/

在这个基于组件的开发时代，鼓励将你的样式、标记和行为共同定位到组件中。每个页面都是一个组件，如果你需要用自己的样式定制页面设计，我们建议将样式与页面组件放在其自己的目录中。例如，要创建一个“支持”页面，你可以执行以下操作之一：

添加一个 /src/pages/support.js 文件
创建一个 /src/pages/support/ 目录和一个 /src/pages/support/index.js 文件。

推荐后者，因为它具有将与页面相关的文件放在该目录中的优点。例如，一个 CSS 模块文件 (styles.module.css)，其样式仅用于“支持”页面。

注意

这仅仅是一个推荐的目录结构，你仍然需要手动在你的组件模块 (support/index.js) 中导入 CSS 模块文件。

默认情况下，任何以 _ 开头的 Markdown 或 JavaScript 文件都将被忽略，并且不会为该文件创建路由（请参阅 exclude 选项）。

my-website
├── src
│   └── pages
│       ├── styles.module.css
│       ├── index.js
│       ├── _ignored.js
│       ├── _ignored-folder
│       │   ├── Component1.js
│       │   └── Component2.js
│       └── support
│           ├── index.js
│           └── styles.module.css
.

警告

src/pages/ 目录中的所有 JavaScript/TypeScript 文件都将为其生成相应的网站路径。如果你想在该目录中创建可重用组件，请使用 exclude 选项（默认情况下，以 _ 为前缀的文件、测试文件 (.test.js) 以及 __tests__ 目录中的文件不会转换为页面）。

重复路由

你可能会不小心创建多个旨在通过相同路由访问的页面。发生这种情况时，当你运行 yarn start 或 yarn build 时，Docusaurus 会警告你存在重复路由（此行为可通过 onDuplicateRoutes 配置），但网站仍将成功构建。最后创建的页面将可访问，但它会覆盖其他冲突页面。要解决此问题，你应该修改或删除任何冲突的路由。

添加 React 页面​

添加 Markdown 页面​

路由​

重复路由​

添加 React 页面

添加 Markdown 页面

路由

重复路由