메인 컨텐츠로 이동
Version: 2.0.0-alpha.75

플러그인

플러그인을 사용하면 MDX 기능을 확장할 수 있습니다.

도큐사우루스에서는 MDX와 함께 동작하는 Remark, Rehype 플러그인을 사용할 수 있습니다.

플러그인 설정하기#

MDX 플러그인은 npm 패키지 형태로 제공됩니다. npm을 사용해 다른 npm 패키지처럼 설치할 수 있습니다.

그럼 먼저 Remark, Rehype 플러그인을 설치합니다.

예를 들면 아래와 같은 형식입니다.

npm install --save remark-imagesnpm install --save rehype-truncate

그리고 플러그인을 가져오는 구문을 작성합니다.

const remarkImages = require('remark-images');const rehypeTruncate = require('rehype-truncate');

마지막으로 docusaurus.config.js 파일 내 @docusaurus/preset-classic 옵션을 아래와 같이 설정합니다.

docusaurus.config.js
module.exports = {  // ...  presets: [    [      '@docusaurus/preset-classic',      {        docs: {          sidebarPath: require.resolve('./sidebars.js'),          // ...          remarkPlugins: [remarkImages],          rehypePlugins: [rehypeTruncate],        },      },    ],  ],};

플러그인 옵션 설정하기#

일부 플러그인은 설정이나 옵션 기능을 지원합니다. 아래 설정에서 [plugin, pluginOptions] 구문이 그러한 항목입니다.

docusaurus.config.js
module.exports = {  // ...  presets: [    [      '@docusaurus/preset-classic',      {        docs: {          sidebarPath: require.resolve('./sidebars.js'),          // ...          remarkPlugins: [            plugin1,            [plugin2, {option1: {...}}],          ],        },      },    ],  ],};

좀 더 자세한 내용은 MDX 문서를 참고하세요.