Merge pull request #21 from Trinoooo/docs/site_and_issue

Docs/site and issue

.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,11 +1,8 @@
 ---
-name: bug_report
-about: You're experiencing an issue with Eggie KV that is different than the documented
-  behavior.
+name: [BUG]报告问题
+about: 当你使用EggieKV时，你遇到了和文档描述行为不一致的问题。
 title: "[BUG](Module): Description"
 labels: bug
-assignees: ''
-
 ---
 
 # 问题描述

.github/ISSUE_TEMPLATE/feature_request.md

@@ -1,10 +1,8 @@
 ---
-name: Feature request
-about: If you have something you think Eggie KV could improve or add support for
+name: [FEAT]功能请求
+about: 如果你认为EggieKv有哪些可改进的地方或者可以支持的地方
 title: "[FEAT]: Description"
 labels: enhancement
-assignees: ''
-
 ---
 
 # 功能请求描述

.github/workflows/pages-test.yaml

@@ -0,0 +1,31 @@
+name: Test Pages
+
+defaults:
+  run:
+    working-directory: ./docs
+
+on:
+  pull_request:
+    branches:
+      - main
+    # Review gh actions docs if you want to further define triggers, paths, etc
+    # https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#on
+
+jobs:
+  test-deploy:
+    name: Test deployment
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 18
+          cache: yarn
+          cache-dependency-path: './docs/yarn.lock'
+
+      - name: Install dependencies
+        run: yarn install --frozen-lockfile
+      - name: Test build website
+        run: yarn build

.github/workflows/pages.yaml

@@ -1,44 +1,50 @@
-name: Page
+name: Pages
+
+defaults:
+  run:
+    working-directory: ./docs
 
 on:
   push:
     branches:
-      - main # default branch
+      - main
+    # Review gh actions docs if you want to further define triggers, paths, etc
+    # https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#on
+
+permissions:
+  contents: write
 
 jobs:
-  build:
+  deploy:
+    name: Deploy to GitHub Pages
     runs-on: ubuntu-latest
-    defaults:
-      run:
-        shell: bash
-        working-directory: ./doc/
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
-          token: ${{ secrets.GITHUB_TOKEN }}
-          submodules: recursive
-      - name: Use Node.js 21.5
-        uses: actions/setup-node@v2
+          fetch-depth: 0
+      - uses: actions/setup-node@v4
         with:
-          node-version: '21'
-      - name: Install Dependencies
-        run: npm install
-      - name: Build
-        run: npm run build
-      - name: Upload Pages artifact
-        uses: actions/upload-pages-artifact@v2
-        with:
-          path: ./doc/public
-  deploy:
-    needs: build
-    permissions:
-      pages: write
-      id-token: write
-    environment:
-      name: github-pages
-      url: ${{ steps.deployment.outputs.page_url }}
-    runs-on: ubuntu-latest
-    steps:
+          node-version: 18
+          cache: yarn
+          cache-dependency-path: './docs/yarn.lock'
+
+      - name: Install dependencies
+        run: yarn install --frozen-lockfile
+      - name: Build website
+        run: yarn build
+
+      # Popular action to deploy to GitHub Pages:
+      # Docs: https://github.com/peaceiris/actions-gh-pages#%EF%B8%8F-docusaurus
       - name: Deploy to GitHub Pages
-        id: deployment
-        uses: actions/deploy-pages@v2
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          # Build output to publish to the `gh-pages` branch:
+          publish_dir: ./build
+          # The following lines assign commit authorship to the official
+          # GH-Actions bot for deploys to `gh-pages` branch:
+          # https://github.com/actions/checkout/issues/13#issuecomment-724415212
+          # The GH actions bot is used by default if you didn't specify the two fields.
+          # You can swap them out with your own user credentials.
+          user_name: github-actions[bot]
+          user_email: 41898282+github-actions[bot]@users.noreply.github.com

README.md

@@ -1,6 +1,6 @@
 # 🌚 Eggie KV
 <div align="center">
-一个简单的、支持持久化的、基于内存的key-value存储
+一个简单的、支持持久化的、基于内存的高性能key-value存储
 
 ![Eggie KV logo](asset/logo.jpeg)