Skip to content

Latest commit

 

History

History
138 lines (106 loc) · 4.04 KB

plugin-content-pages.md

File metadata and controls

138 lines (106 loc) · 4.04 KB
Raw
sidebar_position id title slug
3
plugin-content-pages
📦 plugin-content-pages
/api/plugins/@docusaurus/plugin-content-pages

import APITable from '@site/src/components/APITable';

The default pages plugin for Docusaurus. The classic template ships with this plugin with default configurations. This plugin provides creating pages functionality.

Installation {#installation}

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

:::tip

If you use the preset @docusaurus/preset-classic, you don't need to install this plugin as a dependency.

You can configure this plugin through the preset options.

:::

Configuration {#configuration}

Accepted fields:

Name Type Default Description
path string 'src/pages' Path to data on filesystem relative to site dir. Components in this directory will be automatically converted to pages.
routeBasePath string '/' URL route for the pages section of your site. DO NOT include a trailing slash.
include string[] ['**/*.{js,jsx,ts,tsx,md,mdx}'] Matching files will be included and processed.
exclude string[] See example configuration No route will be created for matching files.
mdxPageComponent string '@theme/MDXPage' Component used by each MDX page.
remarkPlugins [] any[] Remark plugins passed to MDX.
rehypePlugins [] any[] Rehype plugins passed to MDX.
beforeDefaultRemarkPlugins any[] [] Custom Remark plugins passed to MDX before the default Docusaurus Remark plugins.
beforeDefaultRehypePlugins any[] [] Custom Rehype plugins passed to MDX before the default Docusaurus Rehype plugins.

Example configuration {#ex-config}

Here's an example configuration object.

You can provide it as preset options or plugin options.

:::tip

Most Docusaurus users configure this plugin through the preset options.

:::

const config = {
  path: 'src/pages',
  routeBasePath: '',
  include: ['**/*.{js,jsx,ts,tsx,md,mdx}'],
  exclude: [
    '**/_*.{js,jsx,ts,tsx,md,mdx}',
    '**/_*/**',
    '**/*.test.{js,jsx,ts,tsx}',
    '**/__tests__/**',
  ],
  mdxPageComponent: '@theme/MDXPage',
  remarkPlugins: [require('remark-math')],
  rehypePlugins: [],
  beforeDefaultRemarkPlugins: [],
  beforeDefaultRehypePlugins: [],
};

Preset options {#ex-config-preset}

If you use a preset, configure this plugin through the preset options:

module.exports = {
  presets: [
    [
      '@docusaurus/preset-classic',
      {
        // highlight-start
        pages: {
          path: 'src/pages',
          // ... configuration object here
        },
        // highlight-end
      },
    ],
  ],
};

Plugin options {#ex-config-plugin}

If you are using a standalone plugin, provide options directly to the plugin:

module.exports = {
  plugins: [
    [
      '@docusaurus/plugin-content-pages',
      // highlight-start
      {
        path: 'src/pages',
        // ... configuration object here
      },
      // highlight-end
    ],
  ],
};

i18n {#i18n}

Read the i18n introduction first.

Translation files location {#translation-files-location}

  • Base path: website/i18n/<locale>/docusaurus-plugin-content-pages
  • Multi-instance path: website/i18n/<locale>/docusaurus-plugin-content-pages-<pluginId>
  • JSON files: extracted with docusaurus write-translations
  • Markdown files: website/i18n/<locale>/docusaurus-plugin-content-pages

Example file-system structure {#example-file-system-structure}

website/i18n/<locale>/docusaurus-plugin-content-pages
│
│ # translations for website/src/pages
├── first-markdown-page.md
└── second-markdown-page.md