docs(docs,deploy-docs.yml): docs folder: 整理

Author: yiyungent

.github/workflows/deploy-docs.yml

@@ -0,0 +1,31 @@
+name: Build and Deploy Docs
+
+on:
+  push:
+    branches:
+      - master
+jobs:
+  build-and-deploy:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout 🛎️
+      uses: actions/checkout@master
+      
+    - name: Use Node.js 12
+      uses: actions/setup-node@v2-beta
+      with:
+        node-version: '12'
+
+    - name: Install and Build 🔧 
+      run: |
+        cd docs
+        npm install
+        npm run docs:build
+
+    - name: Deploy 🚀
+      uses: JamesIves/[email protected]
+      with:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        BRANCH: gh-pages
+        FOLDER: docs/docs/.vuepress/dist
+

.gitignore

@@ -260,5 +260,3 @@ paket-files/
 __pycache__/
 *.pyc
 
-# VuePress
-docs/.vuepress/dist/

docs/.gitignore

@@ -0,0 +1,4 @@
+# VuePress
+docs/.vuepress/dist/
+
+package-lock.json

docs/README.md

@@ -1,18 +1,18 @@
----
-home: true
-heroImage: /images/logo.gif
-heroText: SimCaptcha
-tagline: 文档构建中
-actionText: 快速上手 →
-actionLink: /Guide/
-features:
-- title: 简洁至上
-  details: 以 约定优于配置 为中心的项目结构，以最少的配置帮助你专注于业务。
-- title: 易扩展
-  details: 享受 面向接口编程 的开发体验，使用 DI 注入验证组件，同时可以开发自定义验证。
-- title: 开箱即用
-  details: SimCaptcha(社区) 为流行前端框架提供了开箱即用的解决方案, 不再需要自己实现, 请见 sim-captcha-js, vue-sim-captcha。
-footer: MIT Licensed | Copyright © 2020-present yiyun
----
+# 介绍
 
+本项目文档采用 `VuePress` 构建
 
+
+# Build
+
+```shell
+npm install
+```
+
+```shell
+npm run docs:dev
+```
+
+```shell
+npm run docs:build
+```

deploy-docs.sh renamed to docs/deploy-docs.sh

@@ -7,7 +7,7 @@
 npm run docs:build
 
 # 进入生成的文件夹
-cd docs/.vuepress/dist
+cd .vuepress/dist
 
 # 如果是发布到自定义域名
 # echo 'www.example.com' > CNAME