📦 plugin-client-redirects

Plugin Docusaurus para gerar um redirecionamento do lado cliente.

Esse plugin irá escrever páginas HTML adicionais no seu site estático, que redireciona o usuário para suas páginas Docusaurus com JavaScript.

note

Este plugin só cria redirecionamentos para a compilação de produção.

caution

É melhor usar redirecionamentos do servidor sempre que possível.

Antes de usar este plugin, você deve verificar se o seu provedor de hospedagem não oferece esta funcionalidade.

Instalação

npm

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

Yarn

yarn add @docusaurus/plugin-client-redirects

Configuração

Uso principal: você tem /myDocusaurusPage, e deseja redirecionar para esta página em /myDocusaurusaurusPage.html:

docusaurus.config.js

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

Segundo uso: você tem /myDocusaurusPage.htmle deseja redirecionar para esta página a partir de /myDocusaurusPage.

docusaurus.config.js

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

Para uma lógica personalizada de redirecionamento, forneça sua própria função createRedirects.

Vamos imaginar você a mudar a url de uma página existente, talvez você queira ter certeza de que a url antiga ainda funciona:

docusaurus.config.js

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

É possível usar uma função para criar os redirecionamentos para cada caminho existente:

docusaurus.config.js

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

Finalmente, é possível usar todas as opções ao mesmo tempo:

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