rewrite doc by VitePress, and release it to GitHub Pages

Author: timzaak

.github/workflows/doc-cd.yml

@@ -0,0 +1,32 @@
+name: spa-client release
+
+on:
+  workflow_dispatch:
+    inputs:
+      tag:
+        required: true
+        description: "git tag to release(this input is meaningless)"
+jobs:
+  docker:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        name: Get Code
+
+      - name: Install Node
+        uses: actions/setup-node@v2
+        with:
+          node-version: "16"
+          cache: "yarn"
+          cache-dependency-path: yarn.lock
+
+      - name: Build Doc
+        run: yarn run docs:build
+
+      - name: Release Doc
+        run: |  
+          cd docs/.vitepress/dist
+          git init
+          git add -A
+          git commit -m 'deploy'
+          git push -f [email protected]:timzaak/spa-server.git master:gh-pages

.gitignore

@@ -1,4 +1,6 @@
 /target
 .idea
 /tmp
-config.conf
+config.conf
+/node_modules
+package-lock.json

Makefile

@@ -47,5 +47,17 @@ ifeq ($(VERSION), )
 	$(error VEDRSION is not set)
 else
 	DOCKER_BUILDKIT=1 docker build . -f SPA-Client.Dockerfile -t="timzaak/client:$(VERSION)"
-    docker push timzaak/spa-client:$(VERSION)
+	docker push timzaak/spa-client:$(VERSION)
 endif
+
+
+release-doc:
+	set -e
+	rm -fr docs/.vitepress/dist/*
+	yarn run docs:build
+	cd docs/.vitepress/dist
+	git init
+	git add -A
+	git commit -m 'deploy'
+	git push -f [email protected]:timzaak/spa-server.git master:gh-pages
+	cd -

README.md

@@ -1,47 +1,22 @@
 # SPA-SERVER
-It's just for static web deployment with server side cache, client side cache and hot reload.   
+It is to provide a static web http server with cache and hot reload.
 
 [中文 README](./README_CN.md)
 
 ## Feature
-- Built with Hyper and Warp.
+- Built with Hyper and Warp, fast and small!
 - SSL with Rustls.
-- Memory cache、client cache and compression(gzip).
-- SPA version control, you can regress or release new version with one HTTP api command.
+- Memory cache, client cache and compression(gzip).
+- Static web version control, you can regress or release new version easily.
 - Hot reload support(Mac and Linux).
-- CORS
-- http redirect to https or both serving at the same time.
-- Docker support(compressed size: 32M)
-- provide cmd/npm package to deply spa with one command.
-
-## Run Server
-You can get all config description in file: [`config.release.conf`](./config.release.conf). If you want to change the server config file path, 
-please set environment variable `SPA_CONFIG=${config_path}`.
-### Run By Code
-```shell
-git clone [email protected]:timzaak/spa-server.git
-cd spa-server
-git submodule init && git submodule update
-cp config.release.conf config.conf # please remember to change `file_dir` in config.conf
-cargo run --bin spa-server 
-```
-### Run Docker
-```shell
-docker run -d -p 80 -p 443 -v $HOST_VOLUME:/data -v $CONFIG:/config.conf timzaak/spa-server:latest
-```
-
-## How To Upload SPA Files
-If you want to integrate with js project, please ref:[example/js-aapp-example](example/js-app-example/README.md), if you want to use commandline tool, please ref [SPA-Client](doc/SPA-Client.md) doc.
-
-## Roadmap
-please ref [Roadmap.md](./doc/Roadmap.md).
-
-If you have any idea, feel free to open issue.
-
-## Why use self maintained warp
-[#171 Add reply::file(path) helper](https://github.com/seanmonstar/warp/issues/171)
-
-This project uses lots of private api at warp/src/filters/fs.rs.
+- CORS support.
+- Http auto redirect to https.
+- Docker support(compressed size: 32M).
+- Provide command line/npm package to deploy spa.
+
+## Document
+There is a nice [document](https://timzaak.github.io/spa-server/) powered by VitePress and GitHub Pages,
+you can quickly start spa-server with this [guide](https://timzaak.github.io/spa-server/guide/getting-started.html). 
 
 ## Project Origin
 More details are described at [SPA 发布辅助工具](https://github.com/timzaak/blog/issues/80) in Chinese.

README_CN.md

@@ -12,6 +12,11 @@
 - http/https 同时服务（http 也可返回 redirect https）。
 - 支持 Docker 镜像(压缩后大小:32M)
 - 提供 命令行/npm包 客户端，一行命令部署
+
+## 文档
+目前将文档托管在 GitHub Pages，地址：https://timzaak.github.io/spa-server， 
+Gitee 上的托管还在走流程中。
+
 ## 服务跑起来
 
 配置文件说明: [`config.release.conf`](./config.release.conf). 
@@ -33,7 +38,7 @@ docker run -d -p 80 -p 443 -v $HOST_VOLUME:/data -v $CONFIG:/config.conf timzaak
 ```
 
 ## 如何部署静态文件
-如果你想集成到JS项目中，请参阅：[example/js-aapp-example](example/js-app-example/README.md), 如果你只想用命令行, 请参阅：[SPA-Client](doc/SPA-Client.md)。
+如果你想集成到JS项目中，请参阅：[example/js-aapp-example](example/js-app-example/README.md)。
 
 ## spa-server 使用场景
 ### 单独使用
@@ -46,7 +51,7 @@ docker run -d -p 80 -p 443 -v $HOST_VOLUME:/data -v $CONFIG:/config.conf timzaak
 2. 所有控制请求，需要对每个实例都发起一遍。
 
 ## 项目规划
-请参阅 [项目规划](./doc/Roadmap.md).
+请参阅 [项目规划](docs/Roadmap.md).
 
 ## 为何自行维护 warp 版本
 [#171 Add reply::file(path) helper](https://github.com/seanmonstar/warp/issues/171)

client/src/lib.rs

@@ -6,11 +6,11 @@ pub mod commands;
 mod config;
 mod upload_files;
 
-use anyhow::Context;
 use crate::api::API;
 use crate::commands::{CliCommand, Commands};
 use crate::config::Config;
 use crate::upload_files::upload_files;
+use anyhow::{anyhow, Context};
 
 use clap::Parser;
 use console::style;
@@ -41,8 +41,12 @@ fn success(message: &str) {
 }
 
 fn run_with_commands(commands: CliCommand) -> anyhow::Result<()> {
-    let config = Config::load(commands.config_dir)
-        .with_context(||"Please set config, you can get help at https://github.com/timzaak/spa-server/blob/master/doc/SPA-Client.md#how-to-use-commandline-of-spa-client")?;
+    let config = Config::load(commands.config_dir).map_err(|e| {
+        Err(anyhow!(
+            "Please set config file path or environment variable correctly, {}",
+            e
+        ));
+    })?;
     println!(
         "spa-client connect to admin server({})",
         &config.server.address

doc/Admin_Server_API.md

@@ -0,0 +1 @@
+/.vitepress/dist