Mizukiプロジェクト入門ガイド

環境依存関係

Mizukiを使い始める前に、システムが以下の要件を満たしていることを確認してください：

• Node.js >= 20
• pnpm >= 9
• Git

Node.jsのインストール

Node.js公式サイトにアクセスして、最新版のNode.jsをダウンロードしてインストールしてください。LTS版の使用を推奨します。

インストール後、ターミナルまたはコマンドプロンプトを開いて以下のコマンドを実行し、Node.jsが正常にインストールされたことを確認してください：

node -v
npm -v

バージョン番号が表示されれば、インストールが成功しています。

pnpmのインストール

まだpnpmをインストールしていない場合は、npmを使ってインストールできます：

npm install -g pnpm

インストール後、ターミナルまたはコマンドプロンプトを開いて以下のコマンドを実行し、pnpmが正常にインストールされたことを確認してください：

pnpm -v

バージョン番号が表示されれば、インストールが成功しています。

Gitのインストール

Git公式サイトにアクセスして、お使いのオペレーティングシステムに適したGitバージョンをダウンロードしてインストールしてください。

インストール後、ターミナルまたはコマンドプロンプトを開いて以下のコマンドを実行し、Gitが正常にインストールされたことを確認してください：

git --version

バージョン番号が表示されれば、インストールが成功しています。

プロジェクト起動手順

1. プロジェクトのクローン

まず、Mizukiプロジェクトをローカルにクローンします：

git clone https://github.com/matsuzaka-yuki/mizuki.git
cd Mizuki

2. 依存関係のインストール

pnpmを使ってプロジェクトの依存関係をインストールします：

pnpm install

3. ブログの設定

プロジェクトを開始する前に、ニーズに応じて設定を行う必要があります：

• src/config.tsファイルを編集してブログ設定をカスタマイズ
• サイト情報、テーマカラー、バナー画像、ソーシャルリンクを更新
• 翻訳設定と特別ページ機能を設定

4. 開発サーバーの起動

以下のコマンドを実行して開発サーバーを起動します：

pnpm dev

起動が成功したら、ブラウザでhttp://localhost:4321にアクセスしてブログを表示できます。

5. ウェブサイトのパッケージ化

以下のコマンドを実行してウェブサイトを静的ファイルにパッケージ化し、distディレクトリに生成します：

pnpm build

生成されたdistディレクトリは、独自のサーバーにデプロイできます。