From 492ddb1b283a35d42d6eafa88873c83ea29d6e6e Mon Sep 17 00:00:00 2001 From: ruabbit <34975428+ruaabbit@users.noreply.github.com> Date: Thu, 5 Dec 2024 21:39:45 +0800 Subject: [PATCH 1/3] actions: Create Github Pages Deploy Workflow --- .github/workflows/deploy.yml | 64 ++++++++++++++++++++++++++++++++++++ 1 file changed, 64 insertions(+) create mode 100644 .github/workflows/deploy.yml diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml new file mode 100644 index 0000000..954dfae --- /dev/null +++ b/.github/workflows/deploy.yml @@ -0,0 +1,64 @@ +name: Deploy VitePress Site +on: + push: + branches: [main] + pull_request: + branches: [main] + workflow_dispatch: + +env: + TZ: Asia/Shanghai + +permissions: + contents: read + pages: write + id-token: write + +concurrency: + group: pages + cancel-in-progress: false + +jobs: + build: + runs-on: ubuntu-latest + strategy: + matrix: + node-version: [20] + steps: + - name: Checkout + uses: actions/checkout@v4 + with: + fetch-depth: 0 + + - name: Setup Node.js + uses: actions/setup-node@v4 + with: + node-version: ${{ matrix.node-version }} + + - name: Install pnpm + uses: pnpm/action-setup@v3 + with: + version: latest + run_install: false + + - name: Install dependencies + run: pnpm install + + - name: Build VitePress site + run: pnpm docs:build + + - name: Upload artifact + uses: actions/upload-pages-artifact@v3 + with: + path: .vitepress/dist + + deploy: + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + runs-on: ubuntu-latest + needs: build + steps: + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v4 From 414be0bbf95b513eeb3dd5aa853fc4c7c3dc3f2f Mon Sep 17 00:00:00 2001 From: Feng Gao Date: Fri, 6 Dec 2024 02:58:15 +0800 Subject: [PATCH 2/3] Add files via upload --- README.md | 188 +++++++++++++++++++++++++++--------------------------- 1 file changed, 94 insertions(+), 94 deletions(-) diff --git a/README.md b/README.md index 160ff83..ee1a163 100644 --- a/README.md +++ b/README.md @@ -1,95 +1,95 @@ -# ITStudio-Wiki - - - -中国海洋大学爱特工作室知识库与合作平台，基于 VitePress 构建的现代化文档网站。 - -## 项目简介 - -ITStudio-Wiki 是爱特工作室的官方文档平台，旨在： -- 提供工作室的完整知识库 -- 促进团队协作和知识共享 -- 展示工作室的发展历程和成果 -- 为新成员提供学习和培训资源 - -## 功能特点 - -- 基于 Markdown 的文档编写 -- 基于 VitePress 的快速静态站点 -- 现代化的界面设计 -- 内置本地搜索功能 -- 响应式设计，支持多端访问 -- 中文优化的文档体验 - -## 快速开始 - -### 环境要求 - -- [Node.js](https://nodejs.org/) >= 18 -- [npm](https://www.npmjs.com/) - -### 安装步骤 - -1. 克隆仓库： -```bash -git clone https://github.com/ITStudioOUC/ITStudio-Wiki.git -cd ITStudio-Wiki -``` - -2. 安装依赖： -```bash -npm install -``` - -### 开发与部署 - -开发模式： -```bash -npm run docs:dev -``` - -构建生产版本： -```bash -npm run docs:build -``` - -预览构建结果： -```bash -npm run docs:preview -``` - -## 项目结构 - -``` -ITStudio-Wiki/ -├── .vitepress/ # VitePress 配置 -│ ├── config.mts # 站点配置文件 -│ └── theme/ # 主题相关文件 -├── src/ # 文档源文件 -│ ├── contact/ # 联系相关页面 -│ ├── public/ # 静态资源文件 -│ ├── wiki/ # Wiki 文档目录 -│ └── index.md # 首页 -└── package.json # 项目配置文件 -``` - -## 参与贡献 - -我们欢迎所有形式的贡献，无论是新功能、文档改进还是问题反馈。 - -1. Fork 本仓库 -2. 创建你的特性分支：`git checkout -b feature/YourFeature` -3. 提交你的改动：`git commit -m 'Add some feature'` -4. 推送到分支：`git push origin feature/YourFeature` -5. 提交 Pull Request - -## 文档编写指南 - -1. 所有文档都使用 Markdown 格式 -2. 文档应放在适当的目录结构中 -3. 图片等静态资源请放在 `src/public` 目录下 -4. 新增文档需要在 `.vitepress/config.mts` 中添加相应的导航配置 - -## 许可证 - +# ITStudio-Wiki + + + +中国海洋大学爱特工作室知识库与合作平台，基于 VitePress 构建的现代化文档网站。 + +## 项目简介 + +ITStudio-Wiki 是中国海洋大学爱特工作室的官方文档平台，旨在： +- 提供工作室的完整知识库 +- 促进团队协作和知识共享 +- 展示工作室的发展历程和成果 +- 为新成员提供学习和培训资源 + +## 功能特点 + +- 基于 Markdown 的文档编写 +- 基于 VitePress 的快速静态站点 +- 现代化的界面设计 +- 内置本地搜索功能 +- 响应式设计，支持多端访问 +- 中文优化的文档体验 + +## 快速开始 + +### 环境要求 + +- [Node.js](https://nodejs.org/) >= 18 +- [npm](https://www.npmjs.com/) + +### 安装步骤 + +1. 克隆仓库： +```bash +git clone https://github.com/ITStudioOUC/ITStudio-Wiki.git +cd ITStudio-Wiki +``` + +2. 安装依赖： +```bash +npm install +``` + +### 开发与部署 + +开发模式： +```bash +npm run docs:dev +``` + +构建生产版本： +```bash +npm run docs:build +``` + +预览构建结果： +```bash +npm run docs:preview +``` + +## 项目结构 + +``` +ITStudio-Wiki/ +├── .vitepress/ # VitePress 配置 +│ ├── config.mts # 站点配置文件 +│ └── theme/ # 主题相关文件 +├── src/ # 文档源文件 +│ ├── contact/ # 联系相关页面 +│ ├── public/ # 静态资源文件 +│ ├── wiki/ # Wiki 文档目录 +│ └── index.md # 首页 +└── package.json # 项目配置文件 +``` + +## 参与贡献 + +我们欢迎所有形式的贡献，无论是新功能、文档改进还是问题反馈。 + +1. Fork 本仓库 +2. 创建你的特性分支：`git checkout -b feature/YourFeature` +3. 提交你的改动：`git commit -m 'Add some feature'` +4. 推送到分支：`git push origin feature/YourFeature` +5. 提交 Pull Request + +## 文档编写指南 + +1. 所有文档都使用 Markdown 格式 +2. 文档应放在适当的目录结构中 +3. 图片等静态资源请放在 `src/public` 目录下 +4. 新增文档需要在 `.vitepress/config.mts` 中添加相应的导航配置 + +## 许可证 + 本项目采用 Apache2 许可证 - 查看 [LICENSE](LICENSE) 文件了解详情 \ No newline at end of file From bbd7447bfde5137e46b1c52283919a9bbb3d61c5 Mon Sep 17 00:00:00 2001 From: Feng Gao Date: Fri, 6 Dec 2024 02:58:51 +0800 Subject: [PATCH 3/3] Add files via upload --- src/index.md | 50 ++++++++++++++++++++++++-------------------------- 1 file changed, 24 insertions(+), 26 deletions(-) diff --git a/src/index.md b/src/index.md index 6da5f27..2f0b3ac 100644 --- a/src/index.md +++ b/src/index.md @@ -1,26 +1,24 @@ ---- -layout: home - -hero: - name: "ITStudio Wiki" - text: "爱特工作室知识库与\n合作平台" - tagline: "Make ITStudio Great Again." - image: - src: /logo.png - alt: "ITStudio Logo" - actions: - - theme: brand - text: 开始探索 - link: /wiki/about/intro - - theme: alt - text: 联系我们 - link: /contact/contactus - -features: - - title: 全面文档支持 - details: 提供详尽的指南、教程和资源，助力您的项目成功。 - - title: 高效协作平台 - details: 在共享知识与工具的基础上，促进团队协作。 - - title: 持续创新与成长 - details: 掌握爱特工作室的最新发展，始终走在前沿。 ---- +--- +layout: home + +hero: + name: "ITStudio Wiki" + text: "爱特工作室知识库与\n合作平台" + tagline: "Make ITStudio Great Again." + image: + src: /logo.png + alt: "ITStudio Logo" + actions: + - theme: brand + text: 开始探索 + link: /wiki/about/intro + - theme: alt + text: 联系我们 + link: /contact/contactus + +features: + - title: 加入我们 + details: 我们欢迎不同专业的、不同特长的同学加入，一起分析技术心得，提高技术水平，体验团队合作， 结识志同道合的朋友。 + - title: 持续创新与成长 + details: 掌握爱特工作室的最新发展，始终走在前沿。 +---