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

feat(docs): Gatsby への移行 #1384

Merged
merged 46 commits into from
Sep 3, 2024
Merged

feat(docs): Gatsby への移行 #1384

merged 46 commits into from
Sep 3, 2024

Conversation

MikuroXina
Copy link
Collaborator

Type of Change:

フレームワークの移行

Dealing with Problems (問題への対処)

Nextra および Next.js の依存関係が古いまま更新されず, まだ自動作成された PR がいつも失敗するためメンテナンスの負担となっていました.

これ以上 Next.js の更新を待っても仕方がないと判断し, 移行先のフレームワークを選定したところ, React コードを流用できて MDX の描画を導入しやすい Gatsby.js を採用することにしました.

Details of implementation (実施内容)

Nextra のテーマで書かれていた部分を独自実装で書き換えました. Callout の部分に関しては視覚の互換性を損なっていますが, MDX の内容は保っています.

元々あったプライマリーカラーを基にカラースキームを Material Theme Builder で生成し, それをライトテーマ/ダークテーマの色に反映させました. テーマをスイッチする UI は無くなりましたが, 最低限の視覚体験を確保してあります.

サイトメニューを自作し, 子のページや兄弟ページへのリンクを作成するようにしました.

Additional Information (追加情報)

正常に描画できることを確認できしだい, Cloudflare Pages のデプロイ設定を Gatsby 用に変更します.

@github-actions github-actions bot added T-@oreorebot2/common Type: OreOreBot2 Common (packages/common) T-@oreorebot2/docs Type: OreOreBot2 Docs (packages/docs) labels Sep 3, 2024
Copy link

codecov bot commented Sep 3, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 59.04%. Comparing base (9e325a6) to head (1d5f7a8).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1384   +/-   ##
=======================================
  Coverage   59.04%   59.04%           
=======================================
  Files         112      112           
  Lines        7337     7337           
  Branches      530      530           
=======================================
  Hits         4332     4332           
  Misses       2476     2476           
  Partials      529      529           
Flag Coverage Δ
unittests 59.04% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link

cloudflare-workers-and-pages bot commented Sep 3, 2024

Deploying oreorebot2 with  Cloudflare Pages  Cloudflare Pages

Latest commit: 1d5f7a8
Status:⚡️  Build in progress...

View logs

@MikuroXina MikuroXina merged commit dce4b6a into main Sep 3, 2024
9 of 10 checks passed
@MikuroXina MikuroXina deleted the gatsby-docs branch September 3, 2024 09:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
T-@oreorebot2/common Type: OreOreBot2 Common (packages/common) T-@oreorebot2/docs Type: OreOreBot2 Docs (packages/docs)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant