📦 plugin-client-redirects

클라이언트 리다이렉트를 처리하기 위한 도큐사우루스 플러그인입니다.

플러그인에서는 자바스크립트로 만든 도큐사우루스 페이지로 리다이렉트할 수 있도록 여러분의 정적인 사이트에 HTML 페이지를 추가로 만듭니다.

note

이 플러그인은 제품 빌드 시에만 리다이렉트 기능을 만듭니다.

caution

가능하다면 서버 측 리다이렉트를 사용하는 것을 권장합니다.

플러그인을 사용하기 전에 여러분의 호스트 서비스 업체게 이 기능을 지원하지 않는지 먼저 확인해보세요.

설치

npm

npm install --save @docusaurus/plugin-client-redirects

Yarn

yarn add @docusaurus/plugin-client-redirects

설정

주로 여러분이 /myDocusaurusPage를 가지고 있을 때 /myDocusaurusPage.html에서 리다이렉트 처리를 위해 사용합니다.

docusaurus.config.js

module.exports = {  plugins: [    [      '@docusaurus/plugin-client-redirects',      {        fromExtensions: ['html'],      },    ],  ],};

두 번째는 /myDocusaurusPage.html를 가지고 있을 때 /myDocusaurusPage에서 리다이렉트 처리를 위해 사용합니다.

docusaurus.config.js

module.exports = {  plugins: [    [      '@docusaurus/plugin-client-redirects',      {        toExtensions: ['html'],      },    ],  ],};

createRedirects 함수를 사용해 사용자 지정 리다이렉트 로직을 적용할 수 있습니다.

페이지의 url을 변경하지만 이전 url도 동작하기를 원할 수 있습니다.

docusaurus.config.js

module.exports = {  plugins: [    [      '@docusaurus/plugin-client-redirects',      {        redirects: [          {            to: '/docs/newDocPath', // string            from: ['/docs/oldDocPathFrom2019', '/docs/legacyDocPathFrom2016'], // string | string[]          },        ],      },    ],  ],};

각 경로에 대한 리다이렉트를 설정하는 함수를 사용해 기능을 지원할 수 있습니다.

docusaurus.config.js

module.exports = {  plugins: [    [      '@docusaurus/plugin-client-redirects',      {        createRedirects: function (existingPath) {          if (existingPath === '/docs/newDocPath') {            return ['/docs/oldDocPathFrom2019', '/docs/legacyDocPathFrom2016']; // string | string[]          }        },      },    ],  ],};

마지막으로 모든 옵션을 한 번에 적용할 수도 있습니다.

docusaurus.config.js

module.exports = {  plugins: [    [      '@docusaurus/plugin-client-redirects',      {        fromExtensions: ['html', 'htm'],        toExtensions: ['exe', 'zip'],        redirects: [          {            to: '/docs/newDocPath',            from: '/docs/oldDocPath',          },        ],        createRedirects: function (existingPath) {          if (existingPath === '/docs/newDocPath2') {            return ['/docs/oldDocPath2'];          }        },      },    ],  ],};