From 01327a97f4dc967ded857816512d2ac91070f4fe Mon Sep 17 00:00:00 2001 From: Ri-Nai Date: Thu, 25 Sep 2025 12:31:32 +0800 Subject: [PATCH 1/2] =?UTF-8?q?docs:=20=E6=9B=B4=E6=96=B0=20README?= =?UTF-8?q?=EF=BC=8C=E6=B7=BB=E5=8A=A0=E6=9C=AC=E5=9C=B0=E5=BC=80=E5=8F=91?= =?UTF-8?q?=E5=92=8C=E5=90=AF=E5=8A=A8=E9=A1=B9=E7=9B=AE=E7=9A=84=E8=AF=B4?= =?UTF-8?q?=E6=98=8E?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 74 +++++++++++++++++++++++++++++++++++++++++++++++++++---- 1 file changed, 69 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 785f4c8..9c2e7de 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ 仓库主体部分于2024年完工，和2025年9月份的舆论事件无关。截止提交时，仓库的贡献者们与老乡鸡的唯一关系只有消费者和商家的关系。本仓库不是老乡鸡的官方仓库。如果有任何问题或意见建议，欢迎指出 -**新更新** +## 新更新 - 欢迎大家来贡献实拍图 @@ -28,14 +28,78 @@ 至于为什么仓库名要叫CookLikeHOC，因为直接写Laoxiangji大概不方便阅读，而Home Original Chicken是china daily报道中所使用的老乡鸡的英文名，故简写成HOC。 -Contributor + +## 本地开发 + +### 前置依赖 + +在开始之前，请确保你的开发环境中安装了 [Node.js](https://nodejs.org/) (推荐 v18.x 或更高版本)。 + +- **Windows:** + + 可以从 [Node.js 官网](https://nodejs.org/en/download/) 下载安装包进行安装。 + 或者使用包管理器 [Chocolatey](https://chocolatey.org/): + ```bash + choco install nodejs + ``` + +- **macOS:** + + 可以从 [Node.js 官网](https://nodejs.org/en/download/) 下载安装包进行安装。 + 或者使用包管理器 [Homebrew](https://brew.sh/): + ```bash + brew install node + ``` + +- **Linux:** + + 对于 Debian/Ubuntu 系统，可以使用 [NodeSource](https://github.com/nodesource/distributions) 来安装: + ```bash + curl -fsSL https://deb.nodesource.com/setup_18.x | sudo -E bash - + sudo apt-get install -y nodejs + ``` + + 对于 RHEL/CentOS 系统: + ```bash + curl -fsSL https://rpm.nodesource.com/setup_18.x | sudo bash - + sudo yum install -y nodejs + ``` + +### 启动项目 + +1. 克隆代码仓库 + + ```bash + git clone https://github.com/Gar-b-age/CookLikeHOC.git + ``` + +2. 进入项目目录 + + ```bash + cd CookLikeHOC + ``` + +3. 安装依赖 + + ```bash + npm install + ``` + +4. 运行 + + ```bash + npm run docs:dev + ``` + + 然后打开浏览器，访问 http://localhost:5173/ 即可。 + +## Contributor ![cr](https://contrib.rocks/image?repo=Gar-b-age/CookLikeHOC) -Logo +## Logo ![pic](/logo.png) -Star History +## Star History [![Star History Chart](https://api.star-history.com/svg?repos=Gar-b-age/CookLikeHOC&type=Date)](https://star-history.com/#Gar-b-age/CookLikeHOC&Date) - From 28779347513f09f55e467de55b4636cddd22aa87 Mon Sep 17 00:00:00 2001 From: Ri-Nai Date: Thu, 25 Sep 2025 15:16:42 +0800 Subject: [PATCH 2/2] =?UTF-8?q?feat:=20=E6=9B=B4=E6=96=B0=E6=8E=92?= =?UTF-8?q?=E9=99=A4=E7=9B=AE=E5=BD=95=E5=88=97=E8=A1=A8=EF=BC=8C=E6=B7=BB?= =?UTF-8?q?=E5=8A=A0=20docs=20=E7=9B=AE=E5=BD=95=EF=BC=9B=E6=96=B0?= =?UTF-8?q?=E5=A2=9E=E6=9C=AC=E5=9C=B0=E5=BC=80=E5=8F=91=E6=96=87=E6=A1=A3?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .vitepress/navSidebar.mjs | 2 +- .vitepress/scripts/generate-indexes.mjs | 2 +- README.md | 72 +++---------------------- docs/development.md | 63 ++++++++++++++++++++++ 4 files changed, 72 insertions(+), 67 deletions(-) create mode 100644 docs/development.md diff --git a/.vitepress/navSidebar.mjs b/.vitepress/navSidebar.mjs index c36ad79..645916b 100644 --- a/.vitepress/navSidebar.mjs +++ b/.vitepress/navSidebar.mjs @@ -2,7 +2,7 @@ import fs from 'node:fs' import path from 'node:path' const DOC_EXT = ['.md'] -const EXCLUDED_DIRS = new Set(['.git', '.github', '.vitepress', 'node_modules', 'public']) +const EXCLUDED_DIRS = new Set(['.git', '.github', '.vitepress', 'node_modules', 'public', 'docs']) function isDirectory(p) { return fs.existsSync(p) && fs.statSync(p).isDirectory() diff --git a/.vitepress/scripts/generate-indexes.mjs b/.vitepress/scripts/generate-indexes.mjs index a37653b..5eee5be 100644 --- a/.vitepress/scripts/generate-indexes.mjs +++ b/.vitepress/scripts/generate-indexes.mjs @@ -2,7 +2,7 @@ import fs from 'node:fs' import path from 'node:path' const ROOT = process.cwd() -const EXCLUDED_DIRS = new Set(['.git', '.github', '.vitepress', 'node_modules', 'public']) +const EXCLUDED_DIRS = new Set(['.git', '.github', '.vitepress', 'node_modules', 'public', 'docs']) function isDirectory(p) { return fs.existsSync(p) && fs.statSync(p).isDirectory() diff --git a/README.md b/README.md index 9c2e7de..7d45321 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,11 @@ ![pic](/banner.png) +
+ +[**Docker Support**](./docker_support/README.md) | [**Development**](./docs/development.md) + +
+ # 像老乡鸡那样做饭 [**一些说明**](https://github.com/Gar-b-age/CookLikeHOC/issues/26) @@ -29,70 +35,6 @@ 至于为什么仓库名要叫CookLikeHOC，因为直接写Laoxiangji大概不方便阅读，而Home Original Chicken是china daily报道中所使用的老乡鸡的英文名，故简写成HOC。 -## 本地开发 - -### 前置依赖 - -在开始之前，请确保你的开发环境中安装了 [Node.js](https://nodejs.org/) (推荐 v18.x 或更高版本)。 - -- **Windows:** - - 可以从 [Node.js 官网](https://nodejs.org/en/download/) 下载安装包进行安装。 - 或者使用包管理器 [Chocolatey](https://chocolatey.org/): - ```bash - choco install nodejs - ``` - -- **macOS:** - - 可以从 [Node.js 官网](https://nodejs.org/en/download/) 下载安装包进行安装。 - 或者使用包管理器 [Homebrew](https://brew.sh/): - ```bash - brew install node - ``` - -- **Linux:** - - 对于 Debian/Ubuntu 系统，可以使用 [NodeSource](https://github.com/nodesource/distributions) 来安装: - ```bash - curl -fsSL https://deb.nodesource.com/setup_18.x | sudo -E bash - - sudo apt-get install -y nodejs - ``` - - 对于 RHEL/CentOS 系统: - ```bash - curl -fsSL https://rpm.nodesource.com/setup_18.x | sudo bash - - sudo yum install -y nodejs - ``` - -### 启动项目 - -1. 克隆代码仓库 - - ```bash - git clone https://github.com/Gar-b-age/CookLikeHOC.git - ``` - -2. 进入项目目录 - - ```bash - cd CookLikeHOC - ``` - -3. 安装依赖 - - ```bash - npm install - ``` - -4. 运行 - - ```bash - npm run docs:dev - ``` - - 然后打开浏览器，访问 http://localhost:5173/ 即可。 - ## Contributor ![cr](https://contrib.rocks/image?repo=Gar-b-age/CookLikeHOC) @@ -102,4 +44,4 @@ ## Star History -[![Star History Chart](https://api.star-history.com/svg?repos=Gar-b-age/CookLikeHOC&type=Date)](https://star-history.com/#Gar-b-age/CookLikeHOC&Date) +[![Star History Chart](https://api.star-history.com/svg?repos=Gar-b-age/CookLikeHOC&type=Date)](https://star-history.com/#Gar-b-age/CookLikeHOC&Date) \ No newline at end of file diff --git a/docs/development.md b/docs/development.md new file mode 100644 index 0000000..7e088e7 --- /dev/null +++ b/docs/development.md @@ -0,0 +1,63 @@ +# 本地开发 + +### 前置依赖 + +在开始之前，请确保你的开发环境中安装了 [Node.js](https://nodejs.org/) (推荐 v18.x 或更高版本)。 + +- **Windows:** + + 可以从 [Node.js 官网](https://nodejs.org/en/download/) 下载安装包进行安装。 + 或者使用包管理器 [Chocolatey](https://chocolatey.org/): + ```bash + choco install nodejs + ``` + +- **macOS:** + + 可以从 [Node.js 官网](https://nodejs.org/en/download/) 下载安装包进行安装。 + 或者使用包管理器 [Homebrew](https://brew.sh/): + ```bash + brew install node + ``` + +- **Linux:** + + 对于 Debian/Ubuntu 系统，可以使用 [NodeSource](https://github.com/nodesource/distributions) 来安装: + ```bash + curl -fsSL https://deb.nodesource.com/setup_18.x | sudo -E bash - + sudo apt-get install -y nodejs + ``` + + 对于 RHEL/CentOS 系统: + ```bash + curl -fsSL https://rpm.nodesource.com/setup_18.x | sudo bash - + sudo yum install -y nodejs + ``` + +### 启动项目 + +1. 克隆代码仓库 + + ```bash + git clone https://github.com/Gar-b-age/CookLikeHOC.git + ``` + +2. 进入项目目录 + + ```bash + cd CookLikeHOC + ``` + +3. 安装依赖 + + ```bash + npm install + ``` + +4. 运行 + + ```bash + npm run docs:dev + ``` + + 然后打开浏览器，访问 http://localhost:5173/ 即可。 \ No newline at end of file