ドキュメンテーションプラットフォーム Mintlify を利用している際に遭遇したエラーと、その解決策について共有します。
Invalid mint.jsonMintlifyでドキュメントサイトを構築するため、公式ドキュメントを参考にしながら設定ファイル mint.json を記述し、ローカルでプレビューしようと mintlify dev コマンドを実行しました。
すると、以下のようなエラーメッセージが表示され、ビルドが失敗してしまいました。
mintlify dev
🚨 Invalid mint.json:
#.navigation: Invalid type. Expected field to be of type 'array', received 'object'
error prebuild step failedエラーメッセージを読むと、mint.json 内の navigation フィールドの型が原因のようです。「array を期待していたのに object を受け取った」と指摘されています。
しかし、私の設定は当時の公式ドキュメントに記載されていた形式であり、何が問題なのかすぐには分かりませんでした。
調査を進めたところ、Mintlifyの設定ファイルが mint.json から docs.json へとアップグレードされていたことが判明しました。
古い mint.json の仕様では navigation がオブジェクト形式だったのに対し、新しい docs.json では配列形式に変更されていたのです。これがエラーの直接的な原因でした。
公式ドキュメントにも、mint.json から docs.json へのアップグレード手順が詳しく記載されていました。
docs.json へのアップグレードで解決公式のアップグレードガイドに従い、設定ファイルを mint.json から docs.json へと移行しました。
npm i -g mintmint updatemint upgraderm mint.jsonこの修正後、mint dev を実行したところ、無事にローカルサーバーが起動し、プレビューできるようになりました。
参考までに、私が実際に行った docs.json へのアップグレード作業のPull Requestを共有します。具体的なファイル差分を確認したい方は、こちらをご覧ください。
もし、あなたが同じエラーに直面したら、まずは設定ファイルが最新の docs.json 仕様に準拠しているかを確認してみてください。
以上、MintlifyのInvalid mint.jsonエラーを解決した、現場からお送りしました。