Quick Start

If you just want to quickly experience building a blog with Kecare, without diving into the generator principles or secondary development right away—just follow this guide to get it running locally.

What You Need to Prepare

Required

Node.js: Used to install theme dependencies and start the theme development server (usually something like Nuxt/Vite)
A Theme Project: Responsible for rendering pages meow

Optional (Recommended)

Git: Convenient for cloning the theme repository (you can also directly download and extract the zip package if you don't have it, meow)

Step 1: Install Kecare CLI

Open the terminal in any directory and execute:

npm create kecare@beta

After installation, you can verify it:

kecare -version

If the version information can be output, it means the installation is successful.

Step 2: Get Sample Themes (Nuxt)

If you are using the example theme, you can clone:

git clone https://github.com/Pamperkyumi/Kecare-theme.git
cd Kecare-theme

If you don't have Git installed, you can also download the theme repository as a zip file, extract it, and then enter the theme directory.

Step 3: Install Dependencies

In the theme directory, execute:

npm install

npm install kecare@beta

You can also use pnpm/yarn/bun to install dependencies meow~

Step 4: Run the Kecare Generator (The Key Command Meow)

Now you don't need to manually find the exe, just use the kecare command to run the generator directly:

kecare gen <主题路径>

For example, if you are currently in the theme directory, you can directly write:

kecare gen .

If you are in another directory, you can write the absolute or relative path:

kecare gen ./Kecare-theme

Step 5: Confirm Successful Startup

If everything is normal, you will see output similar to:

$ nuxt dev
● Nuxt x.x.x ...
➜ Local: http://localhost:3000/

Open the browser and visit:

http://localhost:3000/

Being able to see the site homepage means you've got it up and running ✅

FAQ (Save Me First, Meow)

I don't know meow, sorry meow