Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(docusaurus): upgrade to v3 - JP #3363

Merged
merged 24 commits into from
Jan 16, 2024

Conversation

thetaPC
Copy link
Contributor

@thetaPC thetaPC commented Jan 3, 2024

Issue URL: N/A

What is the current behavior?

Docusaurus was on an old version (v2).

What is the new behavior?

Docusaurus has been updated to the latest version (v3).

  • Caution admonitions have been deprecated. Switched to warning admonitions as recommended.
  • Had to add <!-- prettier-ignore --> to some code snippets because new lines in md files will break the site.
  • Had to change script files' extension to prevent the following error: Error [ERR_REQUIRE_ESM]: require() of ES Module not supported
  • Very minor style changes to make sure the upgrade matches main
  • Docusaurus v2 DocPage component has been replaced by Docusaurus v3 DocRoot component
  • Structure for the versioned sidebars was updated to match the new structure

For more detailed comments on certain files then refer to the EN PR.

Does this introduce a breaking change?

  • Yes
  • No

Other information

Docusaurus highly recommends to switch from .md extension to .mdx. At some point, .md files will be parsed as standard CommonMark. I plan to make another PR that addresses this. I opted to not do it in this PR as it would increase the amount of file changes.

PR for EN.

Copy link

vercel bot commented Jan 3, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
ionic-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jan 12, 2024 1:00am

@thetaPC thetaPC mentioned this pull request Jan 5, 2024
2 tasks
@thetaPC thetaPC changed the title chore(docusaurus): upgrade to v3 chore(docusaurus): upgrade to v3 - JP Jan 5, 2024
@@ -217,7 +217,7 @@ display CSS プロパティは、要素を表示するかどうかを決定し

### Responsive な Display 属性

画面サイズに基づいて表示を変更するクラスもあります。ただ `.ion-hide` ではなく `.ion-hide-{breakpoint}-{dir}` という特定の画面サイズでのみクラスを使用します。{breakpoint}は、[Ionic Breakpoints](#ionic-breakpoints)にリストされているブレークポイント名の 1 つです。 `{dir}` は、指定されたブレークポイントの上 (`up`) または下 (`down`) のすべての画面サイズで要素を非表示にするかどうかです。
画面サイズに基づいて表示を変更するクラスもあります。ただ `.ion-hide` ではなく `.ion-hide-{breakpoint}-{dir}` という特定の画面サイズでのみクラスを使用します。\{breakpoint\}は、[Ionic Breakpoints](#ionic-breakpoints)にリストされているブレークポイント名の 1 つです。 `{dir}` は、指定されたブレークポイントの上 (`up`) または下 (`down`) のすべての画面サイズで要素を非表示にするかどうかです。
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Backslashes are needed otherwise Docusaurus will think that {breakpoint} is a variable.

@thetaPC thetaPC marked this pull request as ready for review January 15, 2024 17:31
@thetaPC thetaPC requested a review from a team as a code owner January 15, 2024 17:31
@thetaPC thetaPC requested review from sean-perkins and liamdebeasi and removed request for a team January 15, 2024 17:31
@thetaPC
Copy link
Contributor Author

thetaPC commented Jan 15, 2024

Adding @liamdebeasi since he's approved the EN PR.

@thetaPC thetaPC merged commit 1b07a0f into translation/jp Jan 16, 2024
4 checks passed
@thetaPC thetaPC deleted the translation/jp-docusaurus-v3 branch January 16, 2024 16:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants