📦 plugin-content-pages

도큐사우루스의 기본 페이지 플러그인입니다. 클래식 템플릿에는 기본 설정으로 플러그인이 포함되어 있습니다. 페이지 만들기 기능을 제공하는 플러그인입니다.

설치

npm

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

Yarn

yarn add @docusaurus/plugin-content-pages

tip

@docusaurus/preset-classic을 설치한 경우에는 플러그인을 따로 설치할 필요는 없습니다.

You can configure this plugin through the preset options.

설정

설정할 수 있는 필드

필드명	타입	기본값	설명
path	string	'src/pages'	사이트 디렉터리에 대한 상대 경로로 파일 시스템에서 데이터의 경로입니다. 디렉토리 내 컴포넌트는 자동으로 페이지로 변환됩니다.
routeBasePath	string	'/'	사이트에서 제공하는 페이지에 대한 URL 경로입니다. 절대 URL 끝에 슬래시를 붙이지 마세요.
include	string[]	['**/*.{js,jsx,ts,tsx,md,mdx}']	일치하는 파일이 포함되어 처리됩니다.
exclude	string[]	예제 설정을 참고하세요	일치하는 파일에 대한 경로를 생성하지 않습니다.
mdxPageComponent	string	'@theme/MDXPage'	각 MDX 페이지에서 사용하는 컴포넌트입니다.
remarkPlugins	[]	any[]	MDX에 전달되는 Remark 플러그인입니다.
rehypePlugins	[]	any[]	MDX에 전달되는 Rehype 플러그인입니다.
beforeDefaultRemarkPlugins	any[]	[]	도큐사우루스 기본 Remark 플러그인보다 먼저 MDX에 전달되는 커스텀 Remark 플러그인입니다.
beforeDefaultRehypePlugins	any[]	[]	도큐사우루스 기본 Rehype 플러그인보다 먼저 MDX에 전달되는 커스텀 Rehype 플러그인입니다.

설정 예시

You can configure this plugin through preset options or plugin options.

tip

Most Docusaurus users configure this plugin through the preset options.

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',
          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: [],
        },
      },
    ],
  ],
};

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',
        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: [],
      },
    ],
  ],
};

i18n

i18n 소개 문서를 먼저 확인해주세요.

번역 파일 위치

• Base path: website/i18n/[locale]/docusaurus-plugin-content-pages
• Multi-instance path: website/i18n/[locale]/docusaurus-plugin-content-pages-[pluginId]
• JSON 파일: docusaurus write-translations 명령 실행 후 만들어진 파일
• Markdown files: website/i18n/[locale]/docusaurus-plugin-content-pages

파일 시스템 구조 예

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