路由

Docusaurus 的路由系统遵循单页应用程序约定：一个路由，一个组件。在本节中，我们将首先讨论三个内容插件（文档、博客和页面）中的路由，然后进一步探讨底层路由系统。

内容插件中的路由

每个内容插件都提供了一个 routeBasePath 选项。它定义了插件附加路由的位置。默认情况下，文档插件将其路由放在 /docs 下；博客插件放在 /blog 下；页面插件放在 / 下。你可以这样思考路由结构：

任何路由都将根据这个嵌套路由配置进行匹配，直到找到一个好的匹配。例如，当给定路由 /docs/configuration 时，Docusaurus 首先进入 /docs 分支，然后在文档插件创建的子路由中搜索。

更改 routeBasePath 可以有效地改变你站点的路由结构。例如，在仅文档模式中，我们提到为文档配置 routeBasePath: '/' 意味着文档插件创建的所有路由都不会有 /docs 前缀，但这并不妨碍你通过其他插件创建更多子路由，如 /blog。

接下来，让我们看看这三个插件如何构建自己的"子路由盒子"。

页面路由

页面路由很直接：文件路径直接映射到 URL，没有其他自定义方式。更多信息请参见页面文档。

用于 Markdown 页面的组件是 @theme/MDXPage。React 页面直接用作路由的组件。

博客路由

博客创建以下路由：

文章列表页面：/、/page/2、/page/3...
- 可以通过 pageBasePath 选项自定义路由。
- 组件是 @theme/BlogListPage。
文章页面：/2021/11/21/algolia-docsearch-migration、/2021/05/12/announcing-docusaurus-two-beta...
- 从每个 Markdown 文章生成。
- 可以通过 slug 前置内容完全自定义路由。
- 组件是 @theme/BlogPostPage。
标签列表页面：/tags
- 可以通过 tagsBasePath 选项自定义路由。
- 组件是 @theme/BlogTagsListPage。
标签页面：/tags/adoption、/tags/beta...
- 通过每篇文章前置内容中定义的标签生成。
- 路由始终基于 tagsBasePath，但子路由可以通过标签的 permalink 字段自定义。
- 组件是 @theme/BlogTagsPostsPage。
归档页面：/archive
- 可以通过 archiveBasePath 选项自定义路由。
- 组件是 @theme/BlogArchivePage。

文档路由

文档是唯一创建嵌套路由的插件。在顶层，它注册版本路径：/、/next、/2.0.0-beta.13... 提供版本上下文，包括布局和侧边栏。这确保在切换单个文档时，侧边栏的状态被保留，并且可以通过导航栏下拉菜单在保持在同一文档的情况下切换版本。使用的组件是 @theme/DocPage。

单个文档在导航栏、页脚、侧边栏等提供后的剩余空间中呈现。例如，此页面 /docs/advanced/routing/，是从文件 ./docs/advanced/routing.md 生成的。使用的组件是 @theme/DocItem。

文档的 slug 前置内容可以自定义路由的最后一部分，但基本路由始终由插件的 routeBasePath 和版本的 path 定义。

文件路径和 URL 路径

在整个文档中，我们始终尽量明确是在讨论文件路径还是 URL 路径。内容插件通常将文件路径直接映射到 URL 路径，例如，./docs/advanced/routing.md 将变成 /docs/advanced/routing。但是，通过 slug，你可以使 URL 完全脱离文件结构。

在 Markdown 中编写链接时，你可能指的是文件路径或URL路径，Docusaurus 会使用几种启发式方法来确定。

如果路径有 @site 前缀，它始终是资源文件路径。
如果路径有 http(s):// 前缀，它始终是 URL 路径。
如果路径没有扩展名，它是 URL 路径。例如，在 URL 为 /docs/advanced/routing 的页面上的链接 [page](../plugins) 将链接到 /docs/plugins。Docusaurus 仅在构建站点时检测断开的链接（当它知道完整的路由结构），但不会对文件的存在做任何假设。这与在 JSX 文件中编写 <a href="../plugins">page</a> 完全等效。
如果路径有 .md(x) 扩展名，Docusaurus 会尝试将该 Markdown 文件解析为 URL，并将文件路径替换为 URL 路径。
如果路径有任何其他扩展名，Docusaurus 会将其视为资源并打包。

以下目录结构可以帮助你可视化这种文件 → URL 映射。假设没有任何页面自定义 slug。

示例站点结构

.
├── blog                            # 博客插件的 routeBasePath: '/blog'
│   ├── 2019-05-28-first-blog-post.md       # -> /blog/2019/05/28/first-blog-post
│   ├── 2019-05-29-long-blog-post.md        # -> /blog/2019/05/29/long-blog-post
│   ├── 2021-08-01-mdx-blog-post.mdx        # -> /blog/2021/08/01/mdx-blog-post
│   └── 2021-08-26-welcome
│       ├── docusaurus-plushie-banner.jpeg
│       └── index.md                        # -> /blog/2021/08/26/welcome
├── docs                            # 文档插件的 routeBasePath: '/docs'；当前版本的基本路径为 '/'
│   ├── intro.md                            # -> /docs/intro
│   ├── tutorial-basics
│   │   ├── _category_.json
│   │   ├── congratulations.md              # -> /docs/tutorial-basics/congratulations
│   │   └── markdown-features.mdx           # -> /docs/tutorial-basics/markdown-features
│   └── tutorial-extras
│       ├── _category_.json
│       ├── manage-docs-versions.md         # -> /docs/tutorial-extras/manage-docs-versions
│       └── translate-your-site.md          # -> /docs/tutorial-extras/translate-your-site
├── src
│   └── pages                       # 页面插件的 routeBasePath: '/'
│       ├── index.module.css
│       ├── index.tsx                       # -> /
│       └── markdown-page.md                # -> /markdown-page
└── versioned_docs
    └── version-1.0.0               # 版本的基本路径为 '/1.0.0'
        ├── intro.md                        # -> /docs/1.0.0/intro
        ├── tutorial-basics
        │   ├── _category_.json
        │   ├── congratulations.md          # -> /docs/1.0.0/tutorial-basics/congratulations
        │   └── markdown-features.mdx       # -> /docs/1.0.0/tutorial-basics/markdown-features
        └── tutorial-extras
            ├── _category_.json
            ├── manage-docs-versions.md     # -> /docs/1.0.0/tutorial-extras/manage-docs-versions
            └── translate-your-site.md      # -> /docs/1.0.0/tutorial-extras/translate-your-site

关于内容插件就说这么多。让我们退一步，谈谈 Docusaurus 应用中路由的工作原理。

路由变成 HTML 文件

因为 Docusaurus 是一个服务器端渲染框架，所有生成的路由都将服务器端渲染为静态 HTML 文件。如果你熟悉 Apache2 等 HTTP 服务器的行为，你就会理解这是如何完成的：当浏览器发送对 /docs/advanced/routing 路由的请求时，服务器将其解释为请求 HTML 文件 /docs/advanced/routing/index.html，并返回该文件。

/docs/advanced/routing 路由可以对应 /docs/advanced/routing/index.html 或 /docs/advanced/routing.html。一些托管提供商通过是否存在尾随斜杠来区分它们，并可能或可能不容忍另一种形式。更多信息请阅读尾随斜杠指南。

例如，上述目录的构建输出是（忽略其他资源和 JS 包）：

上述工作空间的输出

build
├── 404.html                      # /404/
├── blog
│   ├── archive
│   │   └── index.html            # /blog/archive/
│   ├── first-blog-post
│   │   └── index.html            # /blog/first-blog-post/
│   ├── index.html                # /blog/
│   ├── long-blog-post
│   │   └── index.html            # /blog/long-blog-post/
│   ├── mdx-blog-post
│   │   └── index.html            # /blog/mdx-blog-post/
│   ├── tags
│   │   ├── docusaurus
│   │   │   └── index.html        # /blog/tags/docusaurus/
│   │   ├── hola
│   │   │   └── index.html        # /blog/tags/hola/
│   │   └── index.html            # /blog/tags/
│   └── welcome
│       └── index.html            # /blog/welcome/
├── docs
│   ├── 1.0.0
│   │   ├── intro
│   │   │   └── index.html        # /docs/1.0.0/intro/
│   │   ├── tutorial-basics
│   │   │   ├── congratulations
│   │   │   │   └── index.html    # /docs/1.0.0/tutorial-basics/congratulations/
│   │   │   └── markdown-features
│   │   │       └── index.html    # /docs/1.0.0/tutorial-basics/markdown-features/
│   │   └── tutorial-extras
│   │       ├── manage-docs-versions
│   │       │   └── index.html    # /docs/1.0.0/tutorial-extras/manage-docs-versions/
│   │       └── translate-your-site
│   │           └── index.html    # /docs/1.0.0/tutorial-extras/translate-your-site/
│   ├── intro
│   │   └── index.html            # /docs/1.0.0/intro/
│   ├── tutorial-basics
│   │   ├── congratulations
│   │   │   └── index.html        # /docs/tutorial-basics/congratulations/
│   │   └── markdown-features
│   │       └── index.html        # /docs/tutorial-basics/markdown-features/
│   └── tutorial-extras
│       ├── manage-docs-versions
│       │   └── index.html        # /docs/tutorial-extras/manage-docs-versions/
│       └── translate-your-site
│           └── index.html        # /docs/tutorial-extras/translate-your-site/
├── index.html                    # /
└── markdown-page
    └── index.html                # /markdown-page/

如果 trailingSlash 设置为 false，构建将生成 intro.html 而不是 intro/index.html。

所有 HTML 文件将使用绝对 URL 引用其 JS 资源，因此为了正确定位资源，你必须配置 baseUrl 字段。请注意，baseUrl 不会影响发出的包的文件结构：基本 URL 位于 Docusaurus 路由系统的上一级。你可以将 url 和 baseUrl 的总和视为 Docusaurus 站点的实际位置。

例如，发出的 HTML 将包含如下链接：<link rel="preload" href="/assets/js/runtime~main.7ed5108a.js" as="script">。因为绝对 URL 是从主机解析的，如果捆绑包位于路径 https://example.com/base/，则链接将指向 https://example.com/assets/js/runtime~main.7ed5108a.js，这是不存在的。通过指定 /base/ 作为基本 URL，链接将正确指向 /base/assets/js/runtime~main.7ed5108a.js。

本地化站点的语言环境也是基本 URL 的一部分。例如，https://docusaurus.io/zh-CN/docs/advanced/routing/ 的基本 URL 为 /zh-CN/。

生成和访问路由

addRoute 生命周期操作用于生成路由。它向路由树注册一段路由配置，提供一个路由、一个组件和组件所需的 props。Props 和组件都作为路径提供给打包器以 require，因为正如架构概述中解释的那样，服务器和客户端仅通过临时文件通信。

所有路由都聚合在 .docusaurus/routes.js 中，你可以在调试插件的路由面板中查看。

在客户端，我们提供 @docusaurus/router 来访问页面的路由。@docusaurus/router 是 react-router-dom 包的重新导出。例如，你可以使用 useLocation 获取当前页面的位置，使用 useHistory 访问历史对象。（它们与浏览器 API 不完全相同，尽管功能相似。请参考 React Router 文档以获取具体 API。）

这个 API 是服务器端渲染安全的，与仅限浏览器的 window.location 不同。

myComponent.js
import React from 'react';
import {useLocation} from '@docusaurus/router';

export function PageRoute() {
  // React router 提供当前组件的路由，即使在服务器端渲染中也是如此
  const location = useLocation();
  return (
    <span>
      我们当前在 <code>{location.pathname}</code>
    </span>
  );
}

http://localhost:3000

我们当前在 /docs/advanced/routing/

逃离 SPA 重定向

Docusaurus 构建了一个单页应用，其中路由转换是通过 React 路由器的 history.push() 方法完成的。这是在客户端完成的。然而，路由转换发生的先决条件是目标 URL 是我们路由器所知道的。否则，路由器会捕获此路径并显示 404 页面。

如果你在 static 文件夹下放置一些 HTML 页面，它们将被复制到构建输出中，因此可以作为网站的一部分访问，但不是 Docusaurus 路由系统的一部分。我们提供了一个 pathname:// 协议，允许你以非单页应用方式重定向到域的另一部分，就像这是一个外部链接。

- [pathname:///pure-html](pathname:///pure-html)

http://localhost:3000

pathname:///pure-html

pathname:// 协议对于引用静态文件夹中的任何内容很有用。例如，Docusaurus 会将所有 Markdown 静态资源转换为 require() 调用。你可以使用 pathname:// 保持它作为常规链接，而不是被 Webpack 哈希处理。

my-doc.md
![来自静态的图像](pathname:///img/docusaurus.png)

[来自静态的资源](pathname:///files/asset.pdf)

Docusaurus 只会去除 pathname:// 前缀而不处理内容。

内容插件中的路由​

页面路由​

博客路由​

文档路由​

文件路径和 URL 路径​

路由变成 HTML 文件​

生成和访问路由​

逃离 SPA 重定向​