Ir para o conteúdo principal
Version: 2.0.0-beta.9

📦 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 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.

Configuração

Campos aceitos:

NameTypeDefaultDescription
pathstring'src/pages'Path to data on filesystem relative to site dir. Components in this directory will be automatically converted to pages.
routeBasePathstring'/'URL route for the pages section of your site. DO NOT include a trailing slash.
includestring[]['**/*.{js,jsx,ts,tsx,md,mdx}']Matching files will be included and processed.
excludestring[]See example configurationNo route will be created for matching files.
mdxPageComponentstring'@theme/MDXPage'Component used by each MDX page.
remarkPlugins[]any[]Remark plugins passed to MDX.
rehypePlugins[]any[]Rehype plugins passed to MDX.
beforeDefaultRemarkPluginsany[][]Custom Remark plugins passed to MDX before the default Docusaurus Remark plugins.
beforeDefaultRehypePluginsany[][]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: [],
};

Opções de predefinição

Se você usar uma predefinição, configure este plugin através das opções predefinidas:

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

Opções do plugin

Se você estiver usando um plugin independente, forneça opções diretamente para o 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