Mizuki Project Getting Started Guide

Environment Dependencies

Before you start using Mizuki, you need to ensure your system meets the following requirements:

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

Install Node.js

Visit the Node.js official website to download and install the latest version of Node.js. It is recommended to use the LTS version.

After installation, open a terminal or command prompt and run the following commands to verify that Node.js is installed successfully:

node -v
npm -v

If the version number is displayed, it means the installation was successful.

Install pnpm

If you haven't installed pnpm yet, you can install it via npm:

npm install -g pnpm

After installation, open a terminal or command prompt and run the following command to verify that pnpm is installed successfully:

pnpm -v

If the version number is displayed, it means the installation was successful.

Install Git

Visit the Git official website to download and install the Git version suitable for your operating system.

After installation, open a terminal or command prompt and run the following command to verify that Git is installed successfully:

git --version

If the version number is displayed, it means the installation was successful.

Project Startup Steps

1. Clone the Project

First, clone the Mizuki project locally:

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

2. Install Dependencies

Use pnpm to install project dependencies:

pnpm install

3. Configure the Blog

Before starting the project, you need to configure it according to your needs:

• Edit the src/config.ts file to customize blog settings
• Update site information, theme colors, banner images, and social links
• Configure translation settings and special page functions

4. Start the Development Server

Run the following command to start the development server:

pnpm dev

After successful startup, you can access http://localhost:4321 in your browser to view your blog.

5. Package the Website

Run the following command to package the website into static files, generated in the dist directory:

pnpm build

The generated dist directory can be deployed to your own server.