Migrating from Docusaurus v1 to v2 / v3+ for website
@anupriya13 がすでに取り組んでいます。
2025年4月21日 から。
評価
この issue はまだ評価されていません。
説明
Check latest updates from Docusaurus here: https://docusaurus.io/docs
Refer https://github.com/facebook/react-native-website/blob/main/website/docusaurus.config.ts
https://docusaurus.io/docs/migration
🔁 Step-by-Step Migration from Docusaurus v1 → v2
1. 📦 Install Docusaurus v2
bashCopyEditnpm install --save @docusaurus/core@latest @docusaurus/preset-classic@latest
Or if using Yarn:
bashCopyEdityarn add @docusaurus/core@latest @docusaurus/preset-classic@latest
2. 📁 Rename siteConfig.js to docusaurus.config.js
Then start adapting its contents. For example:
v1:
jsCopyEditconst siteConfig = {
title: 'My Site',
tagline: 'The tagline',
...
};
v2:
jsCopyEditmodule.exports = {
title: 'My Site',
tagline: 'The tagline',
url: 'https://yoursite.com',
baseUrl: '/',
...
}
More about docusaurus.config.js:
👉 v2 config reference
3. 🧹 Remove pages/ and use /src/pages
Docusaurus v2 uses src/pages for your custom React pages.
You can convert Markdown docs to use the docs/ folder and React pages into src/pages.
4. 📑 Move docs/, update sidebar
-
Keep your Markdown files under
/docs. -
Create a
sidebars.jsfile for navigation:
jsCopyEditmodule.exports = {
docs: [
{
type: 'category',
label: 'Getting Started',
items: ['intro', 'installation'],
},
],
};
5. 🎨 Update custom styling
-
Put custom CSS into
src/css/custom.css. -
Add it to your config:
jsCopyEdittheme: {
customCss: require.resolve('./src/css/custom.css'),
},
6. ✨ Use Presets
In docusaurus.config.js, use the @docusaurus/preset-classic preset to enable docs/blog/theme:
jsCopyEditpresets: [
[
'@docusaurus/preset-classic',
{
docs: {
sidebarPath: require.resolve('./sidebars.js'),
editUrl: 'https://github.com/your-org/repo/edit/main/docs/',
},
theme: {
customCss: require.resolve('./src/css/custom.css'),
},
},
],
],
7. 🖼 Update Images and Assets
Move static assets like logos, favicons, etc. into /static.
bashCopyEdit/static/img/...
Access them in code like /img/logo.svg.
8. 🧪 Test Locally
bashCopyEditnpx docusaurus start
This runs your site at http://localhost:3000
🧰 Optional: Use Migration Tool
There's a v1 to v2 migration tool to help convert common config:
bashCopyEditnpx @docusaurus/migrate
Run it inside your existing Docusaurus v1 project.
✅ Summary Checklist
Task Done?
| Task | Done? |
|---|---|
| Install v2 packages | 🔜 |
| Rename siteConfig.js | 🔜 |
| Setup docs, src/pages | 🔜 |
| Create sidebars.js | 🔜 |
| Move assets to /static | 🔜 |
| Update styling | 🔜 |
| Run site locally | 🔜 |
To migrate your Docusaurus site to version 3.7, follow these steps:
📦 1. Upgrade Dependencies
Update your Docusaurus packages to the latest versions:
npm install @docusaurus/core@latest @docusaurus/preset-classic@latest
yarn add @docusaurus/core@latest @docusaurus/preset-classic@latest
🔄 2. Review Breaking Changes
Docusaurus v3 introduces updates, especially related to MDX. Review the migration guide to understand necessary changes:
Docusaurus v3 Migration Guide
docusaurus.io
🚀 3. Leverage New Features in v3.7
Docusaurus v3.7 includes several enhancements:
docusaurus.io
React 19 Support.
Rspack Incremental Builds: Improved build performance with Rspack incremental builds enabled by default.
Enhanced Blog Plugin: Support for additional author social icons like Bluesky, Mastodon, Threads, Twitch, YouTube, and Instagram.
New SVGR Plugin: Facilitates importing SVGs as React components.
For a comprehensive list of changes, refer to the v3.7.0 changelog.
docusaurus.io
🧪 4. Test Your Site
After upgrading, run your site locally to ensure everything works as expected:
npm run start
Address any issues that arise during testing.
- 主要言語
- C#
- スター
- 544
- フォーク
- 218
- PR マージ指標
- 30日以内にマージされた PR はありません
環境構築
- Dockerfile または Docker Compose ファイルあり
- プルリクエストのテンプレートあり
- コントリビューションガイドなし
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
microsoft/react-native-windows-samples のほかの issue
-
bug documentation Needs: Triage :mag:
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
-
bug documentation Needs: Triage :mag:
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
-
Document node 18 dependecies対応中かも @Danielweng0902 が 119 日前に担当しました。 オープンdocumentation enhancement good first issue good first issue: easy
難易度 1/5 1時間未満 初心者へのやさしさ 82/100
microsoft/react-native-windows-samples#861 · コメント 2 件 ·
-
Update the sample projects to be compatible with react-native-windows 0.82.0-preview.8再び着手できるかも @iamAbhi-916 が 256 日前に担当しましたが、オープン中のプルリクエストはありません。 オープンenhancement Workstream: Gallery and Samples
microsoft/react-native-windows-samples#1141 · 担当者 1 名 ·
-
Update CI pipeline to windows-latest when main has changes ready再び着手できるかも @vineethkuttan が 343 日前に担当しましたが、オープン中のプルリクエストはありません。 オープンbug
microsoft/react-native-windows-samples#1099 · 担当者 1 名 ·
microsoft/react-native-windows-samples の issue をすべて見る
似ている issue
-
bug
難易度 2/5 1〜3時間 初心者へのやさしさ 62/100
Sector-Vestige/Sector-Vestige#476 ·
メンテナーはふだん 1 日以内に返信
-
S: Untriaged
難易度 2/5 1〜3時間 初心者へのやさしさ 62/100
Trauma-Station/Trauma-Station#5058 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 82/100
メンテナーはふだん 2 日以内に返信
-
難易度 1/5 1時間未満 初心者へのやさしさ 75/100
HoffmanEngineering/3d-print-log-api#243 ·
メンテナーはふだん 1 日以内に返信
-
:books: documentation untriaged
難易度 2/5 1〜3時間 初心者へのやさしさ 66/100
メンテナーはふだん 1 日以内に返信