ドキュメント
docsフォルダについて
プロジェクトには「docs」フォルダ内にサブプロジェクトが含まれています。ここには、現在読んでいるドキュメントが含まれています。
このプロジェクト内ドキュメントの使用は完全に任意です。オンライン版を利用することもできます:オンラインバージョン。
このプロジェクト内ドキュメントを使用する場合 …
これは、mysql-to-zodプロジェクトとは別に構築および実行されます。
ドキュメントプロジェクトは、Astro に基づいており、ローカルの.mdxのファイル(やや強化されたMarkdown)を使用して、ドキュメントをホストするローカルウェブサイトを生成します。
セットアップ
まず、PNPMをインストールし、ターミナルで「docs」フォルダを開き、pnpm install
を実行して、すべての依存関係(Astroを含む)を持つnode_modulesをロードします。(好みでnpm
を使ってもかまいません。)
デプロイ可能なドキュメントの生成
package.json内のスクリプトを使用して、ドキュメントプロジェクトをビルドします。
ブラウザでのドキュメントの表示
package.json内の「dev」または「start」スクリプトを使用してドキュメントプロジェクトを実行します。このモードでは、プロジェクト内のファイルが保存されるごとにドキュメントページがリフレッシュされます。
ブラウザを開き、コンソールに表示されたURLに接続します。そこにある情報を利用して、設定ファイルの設定やスキーマの生成を進めることができます。