🚀 Quick Start

Welcome to SuzuBlog! Follow these steps to quickly set up your blog:

1. Start with Vercel

Ready to launch your own Suzu Blog? Just click the button below to deploy instantly with Vercel:

WARNING

Remember to set the ENABLE_EXPERIMENTAL_COREPACK environment variable to 1 in Vercel to enable pnpm and eliminate warnings.

This will create a new repository with the SuzuBlog template and deploy it to Vercel. You can then customize your blog by following the steps below.

2. Configure Site Information

Locate the config.yml file in the root directory of your project and modify it as follows:

• Set your site title, description, and author information.
• Configure your social links and other customization options.

3. Write Articles

• Place Markdown files in the posts folder. The filename will automatically become the URL of the article.
• To customize pages like "About Me" or "Friends," edit the corresponding files in the posts/_pages directory.

4. Local Deployment/Preview (Optional)

1. Ensure you have installed Node.js.

2. Ensure you have pnpm configured. If you're unsure, you can check and install it by running the following commands:

   pnpm --version

   If the command is not found, you can enable it by running the following commands:

   npm install --global corepack@latest
   corepack enable pnpm

3. After ensuring the prerequisites are met, run the following commands in the root directory of your project to install dependencies and start the local server:

   pnpm install
   pnpm dev

4. Open your browser and visit http://localhost:3000 to preview your blog.

5. Local Build and Preview (the same steps apply if you want to deploy on your server, but remember to enable process guarding):

   If you want to try building and previewing locally, run the following commands:

   pnpm build
   pnpm start

5. Manual Updates (Optional)

Your blog is set up to a manual sync with the latest updates from the SuzuBlog template through GitHub Actions.

Go to the Actions tab in your repository and click on the Sync SuzuBlog Main Branch 🎐 workflow. Click on the Run workflow button to sync the latest updates from the SuzuBlog template.

The following directories are excluded during synchronization to ensure your custom content remains untouched:

• .git: Git configuration files
• public: Your static files
• posts: Your blog posts
• config.yml: Your site configuration file

After the sync is complete, manually check and update your config.yml file to include any new configuration options that may have been added.

INFO

If you encounter any issues, don't forget to check our detailed documentation or join the community for support! ✨