init

.github/workflows/upload_artifact.yaml

@@ -0,0 +1,42 @@
+name: Upload Docs to JFrog
+
+on:
+  push:
+    branches: [main]
+  workflow_dispatch:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0 
+      - uses: pnpm/action-setup@v4
+        with:
+          version: 9
+      - name: Setup Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          cache: pnpm
+      - name: Install dependencies
+        run: pnpm install
+      - name: Build with VitePress
+        run: pnpm docs:build
+      - name: Create Tarball
+        uses: a7ul/[email protected]
+        with:
+          command: c
+          cwd: ${{ github.workspace }}/.vitepress/
+          files: |
+            ./dist
+          outPath: ${{ github.workspace }}/.vitepress/clab-docs.tar.gz
+      - name: Upload Tarball
+        uses: fjogeleit/http-request-action@v1
+        with:
+          url: 'https://jfrog.lcpu.dev/artifactory/cloud-doc/latest.tar.gz'
+          method: 'PUT'
+          bearerToken: ${{ secrets.JFROG_BEARER_TOKEN }}
+          file: ${{ github.workspace }}/.vitepress/clab-docs.tar.gz

.gitignore

@@ -0,0 +1,53 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+
+# Dependency directory
+**/node_modules/**
+_node_modules
+.pnp.cjs
+.pnpm-store
+
+#
+.tmp
+_docpress
+.DS_Store
+
+lib
+tsconfig.tsbuildinfo
+test.lib/
+
+# Visual Studio Code configs
+.vscode/
+
+# JetBrains IDEs
+.idea/
+
+# pnpm uses npm for publishing a new version with
+# dependencies bundled but the npm lockfile is not needed
+# because pnpm use pnpm for installation
+package-lock.json
+
+__package_previews__
+.store
+
+privatePackages/store
+
+yarn.lock
+
+RELEASE.md
+
+.jest-cache
+.verdaccio-cache
+.turbo
+
+## custom modules-dir fixture
+__fixtures__/custom-modules-dir/**/fake_modules/
+__fixtures__/custom-modules-dir/cache/
+__fixtures__/custom-modules-dir/patches/
+
+## VitePress
+
+.vitepress/cache
+.vitepress/dist

.vitepress/config.mts

@@ -0,0 +1,102 @@
+import { defineConfig } from 'vitepress'
+
+export default defineConfig({
+  lang: "zh-CN",
+  title: "PKU Clab 文档",
+  description: "开箱即用的免费云计算服务，为教学与科研服务。",
+  head: [['link', { rel: 'icon', href: '/favicon.ico' }]],
+  lastUpdated: true,
+  base: '/docs',
+  cleanUrls: true,
+  themeConfig: {
+    i18nRouting: false,
+    logo: "/logo.svg",
+    logoLink: '/docs/getting-started/introduction',
+    nav: [
+      { text: 'PKU Clab', link: 'https://clab.pku.edu.cn', target: '_self'},
+      { text: '文档', link: '/getting-started/introduction', activeMatch: '/' },
+
+    ],
+    sidebar: {
+      '/': [
+        {
+          text: '文档',
+          items: [
+            { text: '快速开始', link: '/getting-started/introduction' },
+            { text: '网络', items: [
+              { text: "自组网", link: '/networking/private-network'},
+              { text: "Router和浮动IP", link: '/networking/router-and-floating-ip'},
+              { text: "安全组", link: '/networking/security-group'}
+              ] 
+            },
+            { text: '储存', items: [
+              { text: "Volume类型", link: '/storage/volume-type'},
+              { text: "Volume快照和备份", link: '/storage/volume-snapshots-and-backups'},
+              ] 
+            },
+            { text: '镜像站使用指南', link: '/getting-started/lcpu-mirror' }
+          ]
+        }
+      ],
+    },
+    socialLinks: [
+      { icon: 'github', link: 'https://github.com/lcpu-club' }
+    ],
+    footer: {
+      message: '由北京大学学生 Linux 俱乐部开发并维护',
+      copyright: '© 2024 LCPU Club'
+    },
+    docFooter: {
+      prev: '上一节',
+      next: '下一节'
+    },
+    lastUpdated: {
+      text: '更新于',
+      formatOptions: {
+        dateStyle: 'full',
+        timeStyle: 'medium',
+        forceLocale: true
+      }
+    },
+    editLink: {
+      pattern: 'https://github.com/lcpu-club/clab-docs/edit/main/:path',
+      text: '在GitHub上更新本页'
+    },
+    darkModeSwitchLabel: "颜色选择",
+    lightModeSwitchTitle: "切换至亮色模式",
+    darkModeSwitchTitle: "切换至暗色模式", 
+    sidebarMenuLabel: "目录",
+    returnToTopLabel: "回到顶部",
+    externalLinkIcon: true,
+    search: {
+      provider: 'local',
+      options: {
+        locales: {
+          root: {
+            translations: {
+              button: {
+                buttonText: '搜索',
+                buttonAriaLabel: '搜索'
+              },
+              modal: {
+                displayDetails: '显示详细列表',
+                resetButtonTitle: '重置搜索',
+                backButtonTitle: '关闭搜索',
+                noResultsText: '没有结果',
+                footer: {
+                  selectText: '选择',
+                  selectKeyAriaLabel: '输入',
+                  navigateText: '导航',
+                  navigateUpKeyAriaLabel: '上箭头',
+                  navigateDownKeyAriaLabel: '下箭头',
+                  closeText: '关闭',
+                  closeKeyAriaLabel: 'esc'
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  }
+})

.vitepress/theme/custom.css

@@ -0,0 +1,4 @@
+:root {
+    --vp-font-family-base: /* normal text font */
+    --vp-font-family-mono: /* code font */
+  }

.vitepress/theme/index.mts

@@ -0,0 +1,3 @@
+import DefaultTheme from 'vitepress/theme-without-fonts'
+
+export default DefaultTheme

LICENSE

@@ -0,0 +1,7 @@
+Copyright 2024 LCPU Club
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -0,0 +1 @@
+# PKU Clab Documentation

package.json

@@ -0,0 +1,10 @@
+{
+  "devDependencies": {
+    "vitepress": "^1.3.4"
+  },
+  "scripts": {
+    "docs:dev": "vitepress dev",
+    "docs:build": "vitepress build",
+    "docs:preview": "vitepress preview"
+  }
+}