Migrating from Docusaurus v1 to v2 / v3+ for website
@anupriya13 ci sta già lavorando.
Dal 21/4/2025.
Valutazione
Questa issue non è ancora stata valutata.
Descrizione
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.
- Lingua principale
- C#
- Stelle
- 544
- Fork
- 218
- Metriche di merge delle PR
- Nessuna PR unita negli ultimi 30g
Preparare l'ambiente
- Include un Dockerfile o un file Docker Compose
- Ha un modello di pull request
- Nessuna guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di microsoft/react-native-windows-samples
-
bug documentation Needs: Triage :mag:
Difficoltà 2/5 1-3 ore Idoneità per principianti 78/100
-
bug documentation Needs: Triage :mag:
Difficoltà 2/5 1-3 ore Idoneità per principianti 72/100
-
Document node 18 dependeciesForse già presa @Danielweng0902 l’ha presa 120 giorni fa. Apertadocumentation enhancement good first issue good first issue: easy
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 82/100
microsoft/react-native-windows-samples#861 · 2 commenti ·
-
Update the sample projects to be compatible with react-native-windows 0.82.0-preview.8Forse di nuovo libera @iamAbhi-916 l’ha presa 257 giorni fa e non c’è nessuna pull request aperta. Apertaenhancement Workstream: Gallery and Samples
microsoft/react-native-windows-samples#1141 · 1 assegnatario ·
-
Update CI pipeline to windows-latest when main has changes readyForse di nuovo libera @vineethkuttan l’ha presa 344 giorni fa e non c’è nessuna pull request aperta. Apertabug
microsoft/react-native-windows-samples#1099 · 1 assegnatario ·
Tutte le issue di microsoft/react-native-windows-samples
Issue simili
-
ASP.NET Core container quickstart: `docker-run: debug` task sample is missing its closing braceAperta
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 88/100
microsoft/vscode-docs#10499 ·
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 72/100
I maintainer di solito rispondono entro 1 giorno
-
python triage
Difficoltà 2/5 1-3 ore Idoneità per principianti 72/100
microsoft/semantic-kernel#14615 ·
I maintainer di solito rispondono entro 3 giorni
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 75/100
vzeol/DeployCraft#125 ·
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 72/100
apache/arrow-adbc#4915 · 1 commento ·
I maintainer di solito rispondono entro 1 giorno