跳转至主内容
Version: 2.0.0-beta.0

📦 plugin-content-pages

Docusaurus 的默认页面插件。 此插件附带经典模板及其默认配置。 此插件提供页面创建功能。

安装#

npm install --save @docusaurus/plugin-content-pages
tip

若您已安装 @docusaurus/preset-classic,则无需安装此依赖。 您也可以透过经典预设选项来配置,免于进行下列操作。

配置#

docusaurus.config.js
module.exports = {  plugins: [    [      '@docusaurus/plugin-content-pages',      {        /**         * 相对站点目录的文件系统数据路径。         * 此目录中的组件将自动转换为新页面。         */        path: 'src/pages',        /**         * 站点页面章节的 URL 路由。         * 请勿在结尾添加斜杠。         */        routeBasePath: '',        include: ['**/*.{js,jsx,ts,tsx,md,mdx}'],        /**         * 将不会为匹配文件新建路由。         */        exclude: [          '**/_*.{js,jsx,ts,tsx,md,mdx}',          '**/*.test.{js,ts}',          '**/__tests__/**',        ],        /**         * Markdown 页面所使用的主题组件。         */        mdxPageComponent: '@theme/MDXPage',        /**         * 传递至 MDX 的 Remark 及 Rehype 插件。         */        remarkPlugins: [],        rehypePlugins: [],        /**         * 于 Docusaurus 自带的默认 Remark 及 Rehype 插件前         * 传递至 MDX 的自定义 Remark 及 Rehype 插件。         */        beforeDefaultRemarkPlugins: [],        beforeDefaultRehypePlugins: [],      },    ],  ],};

i18n#

请先阅读 i18n 简介

翻译文件位置#

  • 基础路径website/i18n/<语言>/docusaurus-plugin-content-pages
  • 多实例路径website/i18n/<locale>/docusaurus-plugin-content-pages-<pluginId>
  • JSON 文件:使用 docusaurus write-translations 提取
  • Markdown 文件website/i18n/<语言>/docusaurus-plugin-content-pages

文件系统结构示例#

website/i18n/<语言>/docusaurus-plugin-content-pages# website/src/pages 的译文├── first-markdown-page.md└── second-markdown-page.md