mirror of
https://github.com/facebook/docusaurus.git
synced 2025-06-04 03:42:34 +02:00
improve doc
This commit is contained in:
parent
e057bbd662
commit
812daa8af5
1 changed files with 50 additions and 1 deletions
|
@ -513,7 +513,29 @@ module.exports = {
|
||||||
|
|
||||||
For custom redirect logic, provide your own `createRedirects` function.
|
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"
|
```js title="docusaurus.config.js"
|
||||||
module.exports = {
|
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'];
|
||||||
|
}
|
||||||
|
},
|
||||||
|
},
|
||||||
|
],
|
||||||
|
],
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue