Proposal for migrating to docusaurus v2
See original GitHub issueThe current docs site is running in docusaurus v1 and I would like to migrate it to docusaurus v2. Since these involve a lot of changes I’ve tried to chunk out PRs as much as possible.
Prerequisites for docusaurus v2:
- The markdown has to be Markdown compatible
- There are some
img
andbr
tags that are unclosed - The front matter inside the markdowns have special characters that should be wrapped inside quotes
- There are some invalid MDX syntaxes inside markdown
- Changes in consuming translations - https://docusaurus.io/docs/migration/translated-sites
- There are some
These are some prerequisites that I’ve discovered when I tried to migrate to docusaurus v2 in my local (Basic functions work fine)
related issues:
- https://github.com/babel/website/issues/2546
- https://github.com/babel/website/pull/2044#issuecomment-501659623
I’d like to know maintainers thoughts on this 😄
After minimal migration repro:
Light mode:
Dark mode:
Issue Analytics
- State:
- Created 2 years ago
- Comments:7 (6 by maintainers)
Top Results From Across the Web
Migration overview | Docusaurus
This doc guides you through migrating an existing Docusaurus 1 site to Docusaurus 2.
Read more >Get swag for migrating websites to Docusaurus 2! · Issue #1834
Navigate to every page of the website and see if there's anything special about the page (e.g. importing extra scripts) · Look at...
Read more >We see many GitBook users migrating to Docusaurus and ...
We see many GitBook users migrating to Docusaurus and being satisfied with Docusaurus features, flexibility, UX/UI and performance.
Read more >Blog | Docusaurus по русски
We now recommend Docusaurus 2 as the default choice to start a new Docusaurus project and encourage v1 users to migrate to Docusaurus...
Read more >Is it possible to disable JSX validation on docusaurus v2?
I have a website in docusaurus v1 that I am migrating to v2. It has several docs in .md format with embedded HTML...
Read more >Top Related Medium Post
No results found
Top Related StackOverflow Question
No results found
Troubleshoot Live Code
Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start FreeTop Related Reddit Thread
No results found
Top Related Hackernoon Post
No results found
Top Related Tweet
No results found
Top Related Dev.to Post
No results found
Top Related Hashnode Post
No results found
Top GitHub Comments
I’ve opened a PR with base as
main
andv2
branch from my fork. Is this okay or can you guys create av2
branch that we can maintain in this repo? I’ll send PRs to v2 branch of this repo?Nice!! We could deploy a separate v2 url (or even doc2.babeljs.io) until it’s ready and swap it, depends on how long we think it’ll take (I’ve actually tried to migrate a few times in the past in previous beta’s - partially made me want to try something else) maybe just keep a temporary branch like
v2
until it’s good enough. If we merge into that new branch, it doesn’t really matter if you replace/new folder. Although it will cause some merge conflicts with existing PRs it should be fine since we haven’t been merging too many lately