๐ฆ plugin-client-redirects
ํด๋ผ์ด์ธํธ ๋ฆฌ๋ค์ด๋ ํธ๋ฅผ ์ฒ๋ฆฌํ๊ธฐ ์ํ ๋ํ์ฌ์ฐ๋ฃจ์ค ํ๋ฌ๊ทธ์ธ์ ๋๋ค.
ํ๋ฌ๊ทธ์ธ์์๋ ์๋ฐ์คํฌ๋ฆฝํธ๋ก ๋ง๋ ๋ํ์ฌ์ฐ๋ฃจ์ค ํ์ด์ง๋ก ๋ฆฌ๋ค์ด๋ ํธํ ์ ์๋๋ก ์ฌ๋ฌ๋ถ์ ์ ์ ์ธ ์ฌ์ดํธ์ HTML ํ์ด์ง๋ฅผ ์ถ๊ฐ๋ก ๋ง๋ญ๋๋ค.
ํด๋น ํ๋ฌ๊ทธ์ธ์ ๋น๋ ์ฐ์ถ๋ฌผ์์๋ง ์๋ํ๊ธฐ ๋๋ฌธ์ ๊ฐ๋ฐ ์ค์๋ ๋นํ์ฑํ๋๊ณ ์ ํ ๋น๋ ์์๋ง ํ์ฑํ๋ฉ๋๋ค.
๊ฐ๋ฅํ๋ค๋ฉด ์๋ฒ ์ธก ๋ฆฌ๋ค์ด๋ ํธ๋ฅผ ์ฌ์ฉํ๋ ๊ฒ์ ๊ถ์ฅํฉ๋๋ค.
ํ๋ฌ๊ทธ์ธ์ ์ฌ์ฉํ๊ธฐ ์ ์ ์ฌ๋ฌ๋ถ์ ํธ์คํธ ์๋น์ค ์ ์ฒด๊ฒ ์ด ๊ธฐ๋ฅ์ ์ง์ํ์ง ์๋์ง ๋จผ์ ํ์ธํด๋ณด์ธ์.
์ค์นโ
- npm
- Yarn
- pnpm
npm install --save @docusaurus/plugin-client-redirects
yarn add @docusaurus/plugin-client-redirects
pnpm add @docusaurus/plugin-client-redirects
์ค์ โ
์ค์ ํ ์ ์๋ ํ๋
์ต์ | ํ์ | ๊ธฐ๋ณธ๊ฐ | ์ค๋ช |
---|---|---|---|
fromExtensions | string[] | [] | ๋ฆฌ๋ค์ด๋ ํธ ํ ๊ฒฝ๋ก์์ ์ ๊ฑฐํ ํ์ฅ์์ ๋๋ค. |
toExtensions | string[] | [] | ๋ฆฌ๋ค์ด๋ ํธ ํ ๊ฒฝ๋ก์ ์ถ๊ฐํ ํ์ฅ์์ ๋๋ค. |
redirects | RedirectRule[] | [] | ๋ฆฌ๋ค์ด๋ ํธ ๊ท์น ๋ชฉ๋ก์ ๋๋ค. |
createRedirects | CreateRedirectsFn | undefined | ๋ฆฌ๋ค์ด๋ ํธ ๊ท์น์ ๋ง๋ค๊ธฐ ์ํ ์ฝ๋ฐฑ์ ๋๋ค. ๋ํ์ฌ์ฐ๋ฃจ์ค๋ ์์ฑํ ๋ชจ๋ ๊ฒฝ๋ก์ ๋ํด ์ฝ๋ฐฑ์ ์์ฒญํ๊ณ ๋ฐํ๊ฐ์ ์ฌ์ฉํด ๋ ๋ง์ ๊ฒฝ๋ก๋ฅผ ์ถ๋ ฅํฉ๋๋ค. |
ํ๋ฌ๊ทธ์ธ์์ siteConfig.onDuplicateRoutes
์ค์ ์ ํ์ธํ๊ณ ์ฌ๋ฌ ํ์ผ์ ๊ฐ์ ์์น๋ก ๋ด๋ณด๋ผ ๋ ๋ก๊น
์์ค์ ์กฐ์ ํฉ๋๋ค.
ํ์ โ
RedirectRule
โ
type RedirectRule = {
to: string;
from: string | string[];
};
"from"๊ณผ "to"์ ๊ฐ๋ ์ ์ด ํ๋ฌ๊ทธ์ธ์ ํต์ฌ์ ๋๋ค. "From"์ ์์ฑ_ํ๋ ค๋ ๊ฒฝ๋ก, ์ฆ ์์ฑ๋ ์ถ๊ฐ HTML ํ์ผ์ ์๋ฏธํฉ๋๋ค. "to"๋ ๋ฆฌ๋ค์ด๋ ํธ_ํ๋ ค๋ ๊ฒฝ๋ก๋ฅผ ์๋ฏธํ๋ฉฐ ์ผ๋ฐ์ ์ผ๋ก ๋ํ์ฌ์ฐ๋ฃจ์ค๊ฐ ์ด๋ฏธ ์๊ณ ์๋ ๊ฒฝ๋ก์ ๋๋ค.
์ด ๋๋ฌธ์ ๊ฐ์ "to"์ ๋ํด ์ฌ๋ฌ ๊ฐ์ "from"์ ๊ฐ์ง ์ ์์ต๋๋ค. ๋ชจ๋ ๊ฐ์ ๋ชฉ์ ์ง๋ก ๋ฆฌ๋ค์ด๋ ํธ๋๋ ์ฌ๋ฌ ๊ฐ์ HTML ํ์ผ์ ์์ฑํฉ๋๋ค. ๋ฐ๋ฉด์ "from"์ ํ๋๋ณด๋ค ๋ง์ "to"๋ฅผ ๊ฐ์ง ์ ์์ต๋๋ค. ์์ฑ๋ HTML ํ์ผ์ ๋ช ํํ ๋ชฉ์ ์ง๊ฐ ์์ด์ผ ํฉ๋๋ค.
CreateRedirectsFn
โ
// `path` ๋งค๊ฐ๋ณ์๋ ๋ํ์ฌ์ฐ๋ฃจ์ค๊ฐ ์ด๋ฏธ ์์ฑํ ๋ผ์ฐํธ์
๋๋ค. ์ผ๋ฐ์ ์ผ๋ก "to"์ด๋ฉฐ
// ๋ฐํ๊ฐ์ "from"์ด ๋ฉ๋๋ค. ๊ฑฐ์ง ๊ฐ์ ๋ฐํํ๋ฉด
// ํน์ ๊ฒฝ๋ก์ ๋ํ ๋ฆฌ๋ค์ด๋ ํธ ํ์ด์ง๊ฐ ์์ฑ๋์ง ์์ต๋๋ค.
type CreateRedirectsFn = (path: string) => string[] | string | null | undefined;
์ค์ ์์โ
๋ค์์ ์ค์ ์์์ ๋๋ค:
export default {
plugins: [
[
'@docusaurus/plugin-client-redirects',
{
fromExtensions: ['html', 'htm'], // /myPage.html -> /myPage
toExtensions: ['exe', 'zip'], // /myAsset -> /myAsset.zip (if latter exists)
redirects: [
// /docs/oldDoc -> /docs/newDoc
{
to: '/docs/newDoc',
from: '/docs/oldDoc',
},
// Redirect from multiple old paths to the new path
{
to: '/docs/newDoc2',
from: ['/docs/oldDocFrom2019', '/docs/legacyDocFrom2016'],
},
],
createRedirects(existingPath) {
if (existingPath.includes('/community')) {
// Redirect from /docs/team/X to /community/X and /docs/support/X to /community/X
return [
existingPath.replace('/community', '/docs/team'),
existingPath.replace('/community', '/docs/support'),
];
}
return undefined; // Return a falsy value: no redirect created
},
},
],
],
};