Ir para o conteĆŗdo principal
Version: Canary šŸš§

šŸ“¦ 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. This plugin provides creating pages functionality.

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.

VocĆŖ pode configurar este plugin atravĆ©s das opƧƵes de predefiniĆ§Ć£o.

ConfiguraĆ§Ć£oā€‹

Campos aceitos:

NomeTypePadrĆ£oDescriĆ§Ć£o
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}']Os arquivos correspondentes serĆ£o incluĆ­dos e processados.
excludestring[]See example configurationNo route will be created for matching files.
mdxPageComponentstring'@theme/MDXPage'Componente usado em cada pƔgina MDX.
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ā€‹

VocĆŖ pode configurar este plugin atravĆ©s das opƧƵes de predefiniĆ§Ć£o ou opƧƵes do plugin.

tip

A maioria dos usuĆ”rios do Docusaurus configura este plugin atravĆ©s das configuraƧƵes de predefiniĆ§Ć£o.

If you use a preset, configure this plugin through the opƧƵes de predefiniĆ§Ć£o:

docusaurus.config.js
module.exports = {
presets: [
[
'@docusaurus/preset-classic',
{
pages: {
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: [],
},
},
],
],
};

Markdown front matterā€‹

Markdown pages can use the following Markdown front matter metadata fields, enclosed by a line --- on either side.

Campos aceitos:

NomeTypePadrĆ£oDescriĆ§Ć£o
tĆ­tulostringMarkdown titleThe blog post title.
descriptionstringThe first line of Markdown contentThe description of your page, which will become the <meta name="description" content="..."/> and <meta property="og:description" content="..."/> in <head>, used by search engines.
wrapperClassNamestringClass name to be added to the wrapper element to allow targeting specific page content.
hide_table_of_contentsbooleanfalseWhether to hide the table of contents to the right.
draftbooleanfalseDraft pages will only be available during development.
unlistedbooleanfalseUnlisted pages will be available in both development and production. They will be "hidden" in production, not indexed, excluded from sitemaps, and can only be accessed by users having a direct link.

Exemplo:

---
title: Markdown Page
description: Markdown page SEO description
wrapperClassName: markdown-page
hide_table_of_contents: false
draft: true
---

Markdown page content

i18nā€‹

Read the i18n introduction first.

LocalizaĆ§Ć£o dos arquivos de traduĆ§Ć£oā€‹

  • 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

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