📦 plugin-content-pages

O plugin de páginas padrão para o Docusaurus. O modelo clássico é fornecido com este plugin com configurações padrão. Esse plugin fornece funcionalidade de criação de páginas.

Instalação

npm

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

Yarn

yarn add @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.

Configuração

Campos aceitos:

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.

Configuração de exemplo

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

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

docusaurus.config.js

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

Plugin options

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

docusaurus.config.js

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

i18n

Leia a introdução i18n primeiro.

Localização dos arquivos de tradução

• Caminho base: website/i18n/<locale>/docusaurus-plugin-content-pages
• Caminho de multi-instância: website/i18n/<locale>/docusaurus-plugin-content-pages-<pluginId>
• Arquivos JSON: extraídos com docusaurus escreveu-traduções
• Arquivos Markdown: website/i18n/<locale>/docusaurus-plugin-content-pages

Exemplo de estrutura de sistema de arquivos

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