mirror of
https://github.com/facebook/docusaurus.git
synced 2025-05-18 11:36:53 +02:00
72dcd0d8c5
Co-authored-by: Joshua Chen <sidachen2003@gmail.com> Co-authored-by: Joey Clover <joey@popos.local> Co-authored-by: reece-white <93522192+reece-white@users.noreply.github.com> Co-authored-by: Shreesh Nautiyal <114166000+Shreesh09@users.noreply.github.com> Co-authored-by: Nick Gerleman <nick@nickgerleman.com> Co-authored-by: Chongyi Zheng <git@zcy.dev> Co-authored-by: MCR Studio <99176216+mcrstudio@users.noreply.github.com> Co-authored-by: sebastienlorber <lorber.sebastien@gmail.com> Co-authored-by: Sébastien Lorber <slorber@users.noreply.github.com> Co-authored-by: Ivan Mar (sOkam!) <7308253+heysokam@users.noreply.github.com> Co-authored-by: c0h1b4 <dwidman@gmail.com> Co-authored-by: Janessa Garrow <janessa.garrow@gmail.com> Co-authored-by: ozaki <29860391+OzakIOne@users.noreply.github.com> Co-authored-by: axmmisaka <6500159+axmmisaka@users.noreply.github.com> Co-authored-by: Tatsunori Uchino <tats.u@live.jp> Co-authored-by: Simen Bekkhus <sbekkhus91@gmail.com> Co-authored-by: Sanjaiyan Parthipan <parthipankalayini@gmail.com> Co-authored-by: Jack Robson <143492403+jack-robson@users.noreply.github.com> Co-authored-by: dawei-wang <dawei-wang@users.noreply.github.com> Co-authored-by: eitsupi <50911393+eitsupi@users.noreply.github.com> fix(create-docusaurus): fix readme docusaurus 2 ref (#9487) fix(theme): fix firefox CSS :has() support bug (#9530) fix(theme): docs html sidebar items should always be visible (#9531) fix: v3 admonitions should support v2 title syntax for nested admonitions (#9535) fix(theme-classic): fixed wrong cursor on dropdown menu in navbar, when window is small (#9398) fix(theme): upgrade prism-react-renderer, fix html script and style tag highlighting (#9567) fix: add v2 retrocompatible support for quoted admonitions (#9570) fix(i18n): complete translations for theme-common.json Brazilian Portuguese (pt-BR) (#9477) fix(content-blog): add baseUrl for author.image_url (#9581) fix(type-aliases): add `title` prop for imported inline SVG React components (#9612) fix(utils): Markdown link replacement with <> but no spaces (#9617) fix(live-codeblock): stabilize react-live transformCode callback, fix editor/preview desync (#9631) fix(cli): output help when no conventional config + no subcommand (#9648) fix CI job (#9604) fix Lint Autofix workflow (#9632) fix(pwa-plugin): upgrade workbox (#9668) fix(create-docusaurus): fix init template code blocks, and little improvements (#9696) fix(theme): allow empty code blocks and live playgrounds (#9704) fix(core): various broken anchor link fixes (#9732) fix: remove old useless mdx typedefs (#9733) fix(theme-common): fix missing code block MagicComments style in Visual Basic (.NET) 16 (#9727) fix(core): conditionally include `hostname` parameter when using… (#9407) fix(create-docusaurus): fix typo in init template sample docs (#9783) fix(mdx-loader): allow spaces before `mdx-code-block` info string (#9776) fix(core): links with target "_blank" should no be checked by the broken link checker (#9788) fix(core): broken links optimization behaves differently than non-optimized logic (#9791)
75 lines
2.1 KiB
Text
75 lines
2.1 KiB
Text
---
|
|
slug: /migration/v2/automated
|
|
---
|
|
|
|
# Automated migration
|
|
|
|
The migration CLI automatically migrates your v1 website to a v2 website.
|
|
|
|
:::info
|
|
|
|
Manual work is still required after using the migration CLI, as we can't automate a full migration
|
|
|
|
:::
|
|
|
|
The migration CLI migrates:
|
|
|
|
- Site configurations (from `siteConfig.js` to `docusaurus.config.js`)
|
|
- `package.json`
|
|
- `sidebars.json`
|
|
- `/docs`
|
|
- `/blog`
|
|
- `/static`
|
|
- `versioned_sidebar.json` and `/versioned_docs` if your site uses versioning
|
|
|
|
To use the migration CLI, follow these steps:
|
|
|
|
1. Before using the migration CLI, ensure that `/docs`, `/blog`, `/static`, `sidebars.json`, `siteConfig.js`, `package.json` follow the expected structure.
|
|
|
|
2. To migrate your v1 website, run the migration CLI with the appropriate filesystem paths:
|
|
|
|
```bash
|
|
# migration command format
|
|
npx @docusaurus/migrate migrate <v1 website directory> <desired v2 website directory>
|
|
|
|
# example
|
|
npx @docusaurus/migrate migrate ./v1-website ./v2-website
|
|
```
|
|
|
|
3. To view your new website locally, go into your v2 website's directory and start your development server.
|
|
|
|
```bash npm2yarn
|
|
cd ./v2-website
|
|
npm install
|
|
npm start
|
|
```
|
|
|
|
:::danger
|
|
|
|
The migration CLI updates existing files. Be sure to have committed them first!
|
|
|
|
:::
|
|
|
|
#### Options {#options}
|
|
|
|
You can add option flags to the migration CLI to automatically migrate Markdown content and pages to v2. It is likely that you will still need to make some manual changes to achieve your desired result.
|
|
|
|
| Name | Description |
|
|
| -------- | ------------------------------------------------------ |
|
|
| `--mdx` | Add this flag to convert Markdown to MDX automatically |
|
|
| `--page` | Add this flag to migrate pages automatically |
|
|
|
|
```bash
|
|
# example using options
|
|
npx @docusaurus/migrate migrate --mdx --page ./v1-website ./v2-website
|
|
```
|
|
|
|
:::danger
|
|
|
|
The migration of pages and MDX is still a work in progress.
|
|
|
|
We recommend you to try to run the pages without these options, commit, and then try to run the migration again with the `--page` and `--mdx` options.
|
|
|
|
This way, you'd be able to easily inspect and fix the diff.
|
|
|
|
:::
|