๐ฆ plugin-content-pages
๋ํ์ฌ์ฐ๋ฃจ์ค์ ๊ธฐ๋ณธ ํ์ด์ง ํ๋ฌ๊ทธ์ธ์ ๋๋ค. ํด๋์ ํ ํ๋ฆฟ์๋ ๊ธฐ๋ณธ ์ค์ ์ผ๋ก ํ๋ฌ๊ทธ์ธ์ด ํฌํจ๋์ด ์์ต๋๋ค. ํ์ด์ง ๋ง๋ค๊ธฐ ๊ธฐ๋ฅ์ ์ ๊ณตํ๋ ํ๋ฌ๊ทธ์ธ์ ๋๋ค.
์ค์นโ
- npm
- Yarn
npm install --save @docusaurus/plugin-content-pages
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
- Plugin 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: [],
},
},
],
],
};
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