chore(v2): prepare v2.0.0-beta.6 release (#5473)

* add beta.6 * v2.0.0-beta.6
2025-05-25 06:56:56 +02:00 · 2021-09-02 18:31:42 +02:00 · 2021-09-02 18:31:42 +02:00 · 2611bbb501
commit 2611bbb501
parent cb8718a1e3
108 changed files with 13439 additions and 147 deletions
--- a/website/versioned_docs/version-2.0.0-beta.6/api/plugins/plugin-content-pages.md
+++ b/website/versioned_docs/version-2.0.0-beta.6/api/plugins/plugin-content-pages.md
@ -0,0 +1,135 @@
+---
+id: plugin-content-pages
+title: '📦 plugin-content-pages'
+slug: '/api/plugins/@docusaurus/plugin-content-pages'
+---
+
+The default pages plugin for Docusaurus. The classic template ships with this plugin with default configurations. This plugin provides [creating pages](guides/creating-pages.md) functionality.
+
+## Installation {#installation}
+
+```bash npm2yarn
+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](#ex-config-preset).
+
+:::
+
+## Configuration {#configuration}
+
+Accepted fields:
+
+<small>
+
+| 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. |
+
+</small>
+
+## Example configuration {#ex-config}
+
+Here's an example configuration object.
+
+You can provide it as [preset options](#ex-config-preset) or [plugin options](#ex-config-plugin).
+
+:::tip
+
+Most Docusaurus users configure this plugin through the [preset options](#ex-config-preset).
+
+:::
+
+```js
+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](presets.md#docusauruspreset-classic):
+
+```js title="docusaurus.config.js"
+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:
+
+```js title="docusaurus.config.js"
+module.exports = {
+  plugins: [
+    [
+      '@docusaurus/plugin-content-pages',
+      // highlight-start
+      {
+        path: 'src/pages',
+        // ... configuration object here
+      },
+      // highlight-end
+    ],
+  ],
+};
+```
+
+## i18n {#i18n}
+
+Read the [i18n introduction](../../i18n/i18n-introduction.md) 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`](../../cli.md#docusaurus-write-translations-sitedir)
+- **Markdown files**: `website/i18n/<locale>/docusaurus-plugin-content-pages`
+
+### Example file-system structure {#example-file-system-structure}
+
+```bash
+website/i18n/<locale>/docusaurus-plugin-content-pages
+│
+│ # translations for website/src/pages
+├── first-markdown-page.md
+└── second-markdown-page.md
+```