From aed9b6e1182428adf31c38e0d04dbe4d81250521 Mon Sep 17 00:00:00 2001 From: TN-TechNoob Date: Thu, 5 Jun 2025 14:33:29 +0800 Subject: [PATCH 1/2] Clarify command lines section --- README.md | 29 +++++++++++++++++++++-------- 1 file changed, 21 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 0d5083cdc..2f13556d5 100644 --- a/README.md +++ b/README.md @@ -33,14 +33,27 @@ A static blog template built with [Astro](https://astro.build). 1. Create your blog repository: - [Generate a new repository](https://github.com/saicaca/fuwari/generate) from this template or fork this repository. - - Or run one of the following commands: - ```sh - npm create fuwari@latest - yarn create fuwari - pnpm create fuwari@latest - bun create fuwari@latest - deno run -A npm:create-fuwari@latest - ``` + - Or run one of the following commands: + npm + ```sh + npm create fuwari@latest + ``` + pnpm + ```sh + pnpm create fuwari@latest + ``` + Yarn + ```sh + yarn create fuwari + ``` + Bun + ```sh + bun create fuwari@latest + ``` + Deno + ```sh + deno run -A npm:create-fuwari@latest + ``` 2. To edit your blog locally, clone your repository, run `pnpm install` to install dependencies. - Install [pnpm](https://pnpm.io) `npm install -g pnpm` if you haven't. 3. Edit the config file `src/config.ts` to customize your blog. From 533d4dab743691031dba7499b30481433ecca48c Mon Sep 17 00:00:00 2001 From: TN-TechNoob Date: Sat, 7 Jun 2025 06:48:25 +0800 Subject: [PATCH 2/2] Make it the same as the other language's README --- README.md | 76 +++++++++++++++++++++++++++---------------------------- 1 file changed, 38 insertions(+), 38 deletions(-) diff --git a/README.md b/README.md index 2f13556d5..5304e66c0 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,7 @@ -# 🍥Fuwari -![Node.js >= 20](https://img.shields.io/badge/node.js-%3E%3D20-brightgreen) -![pnpm >= 9](https://img.shields.io/badge/pnpm-%3E%3D9-blue) +# 🍥Fuwari + +![Node.js >= 20](https://img.shields.io/badge/node.js-%3E%3D20-brightgreen) +![pnpm >= 9](https://img.shields.io/badge/pnpm-%3E%3D9-blue) [![DeepWiki](https://img.shields.io/badge/DeepWiki-saicaca%2Ffuwari-blue.svg?logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACwAAAAyCAYAAAAnWDnqAAAAAXNSR0IArs4c6QAAA05JREFUaEPtmUtyEzEQhtWTQyQLHNak2AB7ZnyXZMEjXMGeK/AIi+QuHrMnbChYY7MIh8g01fJoopFb0uhhEqqcbWTp06/uv1saEDv4O3n3dV60RfP947Mm9/SQc0ICFQgzfc4CYZoTPAswgSJCCUJUnAAoRHOAUOcATwbmVLWdGoH//PB8mnKqScAhsD0kYP3j/Yt5LPQe2KvcXmGvRHcDnpxfL2zOYJ1mFwrryWTz0advv1Ut4CJgf5uhDuDj5eUcAUoahrdY/56ebRWeraTjMt/00Sh3UDtjgHtQNHwcRGOC98BJEAEymycmYcWwOprTgcB6VZ5JK5TAJ+fXGLBm3FDAmn6oPPjR4rKCAoJCal2eAiQp2x0vxTPB3ALO2CRkwmDy5WohzBDwSEFKRwPbknEggCPB/imwrycgxX2NzoMCHhPkDwqYMr9tRcP5qNrMZHkVnOjRMWwLCcr8ohBVb1OMjxLwGCvjTikrsBOiA6fNyCrm8V1rP93iVPpwaE+gO0SsWmPiXB+jikdf6SizrT5qKasx5j8ABbHpFTx+vFXp9EnYQmLx02h1QTTrl6eDqxLnGjporxl3NL3agEvXdT0WmEost648sQOYAeJS9Q7bfUVoMGnjo4AZdUMQku50McDcMWcBPvr0SzbTAFDfvJqwLzgxwATnCgnp4wDl6Aa+Ax283gghmj+vj7feE2KBBRMW3FzOpLOADl0Isb5587h/U4gGvkt5v60Z1VLG8BhYjbzRwyQZemwAd6cCR5/XFWLYZRIMpX39AR0tjaGGiGzLVyhse5C9RKC6ai42ppWPKiBagOvaYk8lO7DajerabOZP46Lby5wKjw1HCRx7p9sVMOWGzb/vA1hwiWc6jm3MvQDTogQkiqIhJV0nBQBTU+3okKCFDy9WwferkHjtxib7t3xIUQtHxnIwtx4mpg26/HfwVNVDb4oI9RHmx5WGelRVlrtiw43zboCLaxv46AZeB3IlTkwouebTr1y2NjSpHz68WNFjHvupy3q8TFn3Hos2IAk4Ju5dCo8B3wP7VPr/FGaKiG+T+v+TQqIrOqMTL1VdWV1DdmcbO8KXBz6esmYWYKPwDL5b5FA1a0hwapHiom0r/cKaoqr+27/XcrS5UwSMbQAAAABJRU5ErkJggg==)](https://deepwiki.com/saicaca/fuwari) [![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fsaicaca%2Ffuwari.svg?type=shield&issueType=license)](https://app.fossa.com/projects/git%2Bgithub.com%2Fsaicaca%2Ffuwari?ref=badge_shield&issueType=license) @@ -32,30 +33,29 @@ A static blog template built with [Astro](https://astro.build). ## 🚀 Getting Started 1. Create your blog repository: - - [Generate a new repository](https://github.com/saicaca/fuwari/generate) from this template or fork this repository. - - Or run one of the following commands: - npm - ```sh - npm create fuwari@latest - ``` - pnpm - ```sh - pnpm create fuwari@latest - ``` - Yarn - ```sh - yarn create fuwari - ``` - Bun - ```sh - bun create fuwari@latest - ``` - Deno - ```sh - deno run -A npm:create-fuwari@latest - ``` + + - [Generate a new repository](https://github.com/saicaca/fuwari/generate) from this template or fork this repository. + - Or run one of the following commands: + + ```sh + # npm + npm create fuwari@latest + + # yarn + yarn create fuwari + + # pnpm + pnpm create fuwari@latest + + # bun + bun create fuwari@latest + + # deno + deno run -A npm:create-fuwari@latest + ``` + 2. To edit your blog locally, clone your repository, run `pnpm install` to install dependencies. - - Install [pnpm](https://pnpm.io) `npm install -g pnpm` if you haven't. + - Install [pnpm](https://pnpm.io) `npm install -g pnpm` if you haven't. 3. Edit the config file `src/config.ts` to customize your blog. 4. Run `pnpm new-post ` to create a new post and edit it in `src/content/posts/`. 5. Deploy your blog to Vercel, Netlify, GitHub Pages, etc. following [the guides](https://docs.astro.build/en/guides/deploy/). You need to edit the site configuration in `astro.config.mjs` before deployment. @@ -71,7 +71,7 @@ image: ./cover.jpg tags: [Foo, Bar] category: Front-end draft: false -lang: jp # Set only if the post's language differs from the site's language in `config.ts` +lang: jp # Set only if the post's language differs from the site's language in `config.ts` --- ``` @@ -87,17 +87,17 @@ In addition to Astro's default support for [GitHub Flavored Markdown](https://gi All commands are run from the root of the project, from a terminal: -| Command | Action | -|:---------------------------|:----------------------------------------------------| -| `pnpm install` | Installs dependencies | -| `pnpm dev` | Starts local dev server at `localhost:4321` | -| `pnpm build` | Build your production site to `./dist/` | -| `pnpm preview` | Preview your build locally, before deploying | -| `pnpm check` | Run checks for errors in your code | -| `pnpm format` | Format your code using Biome | -| `pnpm new-post ` | Create a new post | -| `pnpm astro ...` | Run CLI commands like `astro add`, `astro check` | -| `pnpm astro --help` | Get help using the Astro CLI | +| Command | Action | +| :------------------------- | :----------------------------------------------- | +| `pnpm install` | Installs dependencies | +| `pnpm dev` | Starts local dev server at `localhost:4321` | +| `pnpm build` | Build your production site to `./dist/` | +| `pnpm preview` | Preview your build locally, before deploying | +| `pnpm check` | Run checks for errors in your code | +| `pnpm format` | Format your code using Biome | +| `pnpm new-post ` | Create a new post | +| `pnpm astro ...` | Run CLI commands like `astro add`, `astro check` | +| `pnpm astro --help` | Get help using the Astro CLI | ## ✏️ Contributing