chvmvd
commented
1 year ago やること
移行への準備
- [x] Node.js 18への更新 #532
- [x] 拡張子を
.mdxに移行 #534 - [x] MDX checker CLIを使いながら、移行のためにMDXの記法を修正 #540
移行
- [x] 依存関係の更新 #541
- [x] math関係のパッケージを更新 #541
移行後
- [x] JSXとMarkdownの間の空行が不要になった。#543
- [x] JSX内でMarkdownのインデントが可能になった。#543
- [x] Admonitionの変更 #547
- [x] React 18への移行により
import React from 'react';が不要 #546 - [x] MDX文法への完全な移行
- [x] HTMLコメントからMDXコメントへの移行 #545
- [x] Admonitionの文法の移行 #548
- [x] 設定ファイルのESMへの移行 #550
Docusaurus 3.0.0に移行
Docursaurus 3.0.0がリリースされたので、移行する。 https://github.com/facebook/docusaurus/releases/tag/v3.0.0 https://docusaurus.io/docs/migration/v3
影響する変更
依存関係の更新
https://docusaurus.io/docs/migration/v3#upgrading-dependencies
Node.js 18への更新
https://docusaurus.io/docs/migration/v3#nodejs-v180
Admonitionの変更
https://docusaurus.io/docs/migration/v3#admonition-warning
React 18への移行により
import React from 'react';が不要https://docusaurus.io/docs/migration/v3#automatic-jsx-runtime
設定ファイルのESMへの移行
https://docusaurus.io/docs/migration/v3#esm-and-typescript-configs
拡張子を
.mdxに移行https://docusaurus.io/docs/migration/v3#using-the-mdx-extension
math関係のパッケージを更新
https://docusaurus.io/docs/migration/v3#upgrading-math-packages
MDX文法への完全な移行
https://docusaurus.io/docs/migration/v3#turn-off-mdx-v1-compat
HTMLコメントからMDXコメントへの移行
https://docusaurus.io/docs/migration/v3#comments-option
Admonitionの文法の移行
https://docusaurus.io/docs/migration/v3#admonitions-option
MDX v1からv3への移行
MDX checker CLI https://github.com/slorber/docusaurus-mdx-checker
MDX v1からv2への移行
https://mdxjs.com/migrating/v2/ かなり大きな変更がある。次がこのリポジトリに影響する変更
MDX v2からv3への移行
https://mdxjs.com/migrating/v3/ 大きな変更はない。