From 218c43abd93898c3b9468426bbf31c678c7ef093 Mon Sep 17 00:00:00 2001 From: simeng Date: Mon, 22 Sep 2025 09:27:05 -0400 Subject: [PATCH] =?UTF-8?q?=E6=9B=B4=E6=96=B0=E4=BB=8B=E7=BB=8D?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 52 ++++++++++++++++++++++++++++++++++++++----------- README.zh-CN.md | 52 ++++++++++++++++++++++++++++++++++++++----------- 2 files changed, 82 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index 9a02682..ba95820 100644 --- a/README.md +++ b/README.md @@ -1,27 +1,57 @@ -# si-meng-web-site-notes +# 祀梦的笔记网站 -The Site is generated using [vuepress](https://vuepress.vuejs.org/) and [vuepress-theme-plume](https://github.com/pengzhanbo/vuepress-theme-plume) +[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) -## Install +一个基于 VuePress 的个人学习笔记和博客网站，记录编程学习、算法练习和日常生活的点滴。 + +## 项目简介 + +这个网站是我（祀梦）记录学习和生活的个人空间，主要包含以下内容： + +- **编程笔记**：记录C++、LeetCode算法等编程相关的学习笔记 +- **博客**：分享日常生活和学习心得 +- **工具推荐**：记录实用的开发工具和资源 +- **友情链接**：展示朋友的个人网站 + +## 技术栈 + +- [VuePress](https://vuepress.vuejs.org/) - 静态网站生成器 +- [VuePress Theme Plume](https://theme-plume.vuejs.press/) - 美观的博客主题 +- [Vue 3](https://vuejs.org/) - 前端框架 +- [Vite](https://vitejs.dev/) - 构建工具 + +## 安装 + +确保您的 Node.js 版本符合要求（^20.6.0 || >=22.0.0），然后执行以下命令： ```sh npm i ``` -## Usage +## 使用 ```sh -# start dev server +# 启动开发服务器（带热重载） npm run docs:dev -# build for production + +# 清除缓存并启动开发服务器 +npm run docs:dev-clean + +# 构建生产版本 npm run docs:build -# preview production build in local + +# 本地预览生产版本 npm run docs:preview -# update vuepress and theme + +# 更新 VuePress 和主题 npm run vp-update ``` -## Documents +## 文档链接 -- [vuepress](https://vuepress.vuejs.org/) -- [vuepress-theme-plume](https://theme-plume.vuejs.press/) +- [VuePress 官方文档](https://vuepress.vuejs.org/) +- [VuePress Theme Plume 文档](https://theme-plume.vuejs.press/) + +## License + +This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details. diff --git a/README.zh-CN.md b/README.zh-CN.md index 4f70c93..8dd3c8e 100644 --- a/README.zh-CN.md +++ b/README.zh-CN.md @@ -1,27 +1,57 @@ -# si-meng-web-site-notes +# 祀梦的笔记网站 -网站使用 [vuepress](https://vuepress.vuejs.org/) 和 [vuepress-theme-plume](https://github.com/pengzhanbo/vuepress-theme-plume) 构建生成。 +[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) -## Install +一个基于 VuePress 的个人学习笔记和博客网站，记录编程学习、算法练习和日常生活的点滴。 + +## 项目简介 + +这个网站是我（祀梦）记录学习和生活的个人空间，主要包含以下内容： + +- **编程笔记**：记录C++、LeetCode算法等编程相关的学习笔记 +- **博客**：分享日常生活和学习心得 +- **工具推荐**：记录实用的开发工具和资源 +- **友情链接**：展示朋友的个人网站 + +## 技术栈 + +- [VuePress](https://vuepress.vuejs.org/) - 静态网站生成器 +- [VuePress Theme Plume](https://theme-plume.vuejs.press/) - 美观的博客主题 +- [Vue 3](https://vuejs.org/) - 前端框架 +- [Vite](https://vitejs.dev/) - 构建工具 + +## 安装 + +确保您的 Node.js 版本符合要求（^20.6.0 || >=22.0.0），然后执行以下命令： ```sh npm i ``` -## Usage +## 使用 ```sh -# 启动开发服务 +# 启动开发服务器（带热重载） npm run docs:dev -# 构建生产包 + +# 清除缓存并启动开发服务器 +npm run docs:dev-clean + +# 构建生产版本 npm run docs:build -# 本地预览生产服务 + +# 本地预览生产版本 npm run docs:preview -# 更新 vuepress 和主题 + +# 更新 VuePress 和主题 npm run vp-update ``` -## 文档 +## 文档链接 -- [vuepress](https://vuepress.vuejs.org/) -- [vuepress-theme-plume](https://theme-plume.vuejs.press/) +- [VuePress 官方文档](https://vuepress.vuejs.org/) +- [VuePress Theme Plume 文档](https://theme-plume.vuejs.press/) + +## 许可证 + +本项目采用 MIT 许可证 - 详见 [LICENSE](LICENSE) 文件。