3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-06-02 10:52:35 +02:00
Code Issues Projects Releases Packages Wiki Activity

improve doc

Browse source
This commit is contained in:
slorber 2020-06-03 18:13:10 +02:00
parent e057bbd662
commit 812daa8af5
1 changed files with 50 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

51
website/docs/using-plugins.md
View file

@ -513,7 +513,29 @@ module.exports = {
For custom redirect logic, provide your own `createRedirects` function.
Let's imagine you change the url of an pexisting age, you might want to make sure the old url still works:
Let's imagine you change the url of an existing page, you might want to make sure the old url still works:
```js title="docusaurus.config.js"
module.exports = {
plugins: [
[
'@docusaurus/plugin-client-redirects',
{
redirects: [
{
// : string
to: '/docs/newDocPath',
// : string | string[]
from: ['/docs/oldDocPathFrom2019', '/docs/legacyDocPathFrom2016'],
},
],
},
],
],
};
```
It's possible to use a function to create the redirects for each existing path:
```js title="docusaurus.config.js"
module.exports = {
@ -531,3 +553,30 @@ module.exports = {
],
};
```
Finally, it's possible to use all options at the same time:
```js title="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'];
}
},
},
],
],
};
```