feat: origin

Author: ZCShou

.github/workflows/deploy.yml

@@ -0,0 +1,50 @@
+name: Deploy to GitHub Pages
+
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - main
+
+jobs:
+  build:
+    name: Build Docusaurus
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 18
+          cache: yarn
+
+      - name: Install dependencies
+        run: yarn install --frozen-lockfile
+      - name: Build website
+        run: yarn build
+
+      - name: Upload Build Artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: build
+
+  deploy:
+    name: Deploy to GitHub Pages
+    needs: build
+
+    # Grant GITHUB_TOKEN the permissions required to make a Pages deployment
+    permissions:
+      pages: write # to deploy to Pages
+      id-token: write # to verify the deployment originates from an appropriate source
+
+    # Deploy to the github-pages environment
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+
+    runs-on: ubuntu-latest
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.gitignore

@@ -0,0 +1,20 @@
+# Dependencies
+/node_modules
+
+# Production
+/build
+
+# Generated files
+.docusaurus
+.cache-loader
+
+# Misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*

README.md

@@ -0,0 +1,61 @@
+<div align="center">
+
+<img src="https://arceos-hypervisor.github.io/images/site/logo.svg" alt="axvisor-logo" width="64">
+
+</div>
+
+<h2 align="center">AxVisor</h1>
+
+<p align="center">A unified modular hypervisor based on ArceOS</p>
+
+<!-- <div align="center">
+
+[![GitHub stars](https://img.shields.io/github/stars/arceos-hypervisor/AxVisor?logo=github)](https://github.com/arceos-hypervisor/AxVisor/stargazers)
+[![GitHub forks](https://img.shields.io/github/forks/arceos-hypervisor/AxVisor?logo=github)](https://github.com/arceos-hypervisor/AxVisor/network)
+[![license](https://img.shields.io/github/license/arceos-hypervisor/AxVisor)](https://github.com/ZCShou/GoGoGo/blob/master/LICENSE)
+
+</div> -->
+
+English | [中文版](README_CN.md)
+
+# Introduction
+
+This repository is the source repository for the AxVisor documentation built using [Docusaurus](https://docusaurus.io/). Docusaurus is an open-source website generator tool developed by Meta, based on React, for creating, maintaining, and deploying static websites.
+
+## Development
+
+Docusaurus is actually a set of Node.js packages, so this documentation is essentially a Node.js application. Therefore, the first step is to ensure that the Node.js environment is correctly installed.
+
+1. Yarn is used as the package manager. By default, yarn is not installed in Node.js, so first, use the command `npm install -g yarn` to install it globally.
+2. To start development for the first time, you need to run the command `yarn install` to install the required dependencies.
+3. Use any editor (VS Code is recommended) to modify the source code and edit new documents (all in Markdown format)
+4. Running the command `yarn start` will start a local development server and automatically open a browser window to preview the entire website.
+
+## Deploy
+
+Currently, the AxVisor documentation website is hosted on GitHub Pages. The repository is configured by default to deploy via GitHub Actions. When the source code is committed to the repository, it will automatically trigger GitHub Actions to deploy the website.
+
+> It also supports yarn deploy for deploying to a separate branch (after modifying the repository configuration).
+>  - Linux:
+>    - Use SSH:
+>        ```
+>        $ USE_SSH=true yarn deploy
+>        ```
+> 
+>    - Not use SSH:
+> 
+>        ```
+>        $ GIT_USER=<Your GitHub username> yarn deploy
+>        ```
+>  - Windows PowerShell:
+>    - Use SSH:
+> 
+>        ```
+>        $ cmd /C 'set "USE_SSH=true" && yarn deploy'
+>        ```
+> 
+>    - Not use SSH:
+> 
+>        ```
+>        $ cmd /C 'set "GIT_USER=<Your GitHub username>" && yarn deploy'
+>        ```

README_CN.md

@@ -0,0 +1,61 @@
+<div align="center">
+
+<img src="https://arceos-hypervisor.github.io/images/site/logo.svg" alt="axvisor-logo" width="64">
+
+</div>
+
+<h2 align="center">AxVisor</h1>
+
+<p align="center">一个基于 ArceOS 的统一模块化虚拟机管理程序</p>
+
+<!-- <div align="center">
+
+[![GitHub stars](https://img.shields.io/github/stars/arceos-hypervisor/AxVisor?logo=github)](https://github.com/arceos-hypervisor/AxVisor/stargazers)
+[![GitHub forks](https://img.shields.io/github/forks/arceos-hypervisor/AxVisor?logo=github)](https://github.com/arceos-hypervisor/AxVisor/network)
+[![license](https://img.shields.io/github/license/arceos-hypervisor/AxVisor)](https://github.com/ZCShou/GoGoGo/blob/master/LICENSE)
+
+</div> -->
+
+[English](README.md) | 中文版
+
+# 简介
+
+本仓库是使用 [Docusaurus](https://docusaurus.io/) 构建 AxVisor 的文档的源码仓库。Docusaurus 是有 Meta 开源的基于 React 开发的一个用于创建、维护和部署静态网站的网站生成工具。
+
+## 开发
+
+Docusaurus 实际上是一组 Node.js 包，因此，本文档实际上是一个 Node.js 应用。所以，首先需要确保正确安装了 Node.js 环境。
+
+1. 使用 `yarn` 作为维护工具，默认的 Node.js 中并没有安装 `yarn`，因此，首先使用命令 `npm install -g yarn` 进行全局安装
+2. 首次进行开发需要先试用命令 `yarn install` 安装所需的依赖包
+3. 使用任意编辑器（推荐 VS Code）进行修改源码，编辑新文档（全部采用 Markdown 格式）
+4. 通过命令 `yarn start` 将会在本地启动的开发服务器，并自动打开浏览器窗口预览整个网站
+
+## 部署
+
+目前，AxVisor 的文档网站托管在了 GitHub Pages 上，仓库默认配置为通过 GitHub Action 进行部署，当把源码提交到仓库之后将自动触发 GitHub Action 进行部署。
+
+> 也支持 `yarn deploy` 进行独立分支部署（需修改仓库配置后）
+>  - Linux:
+>    - 使用 SSH 方式:
+>        ```
+>        $ USE_SSH=true yarn deploy
+>        ```
+> 
+>    - 不使用 SSH 方式:
+> 
+>        ```
+>        $ GIT_USER=<Your GitHub username> yarn deploy
+>        ```
+>  - Windows PowerShell:
+>    - 使用 SSH 方式:
+> 
+>        ```
+>        $ cmd /C 'set "USE_SSH=true" && yarn deploy'
+>        ```
+> 
+>    - 不使用 SSH 方式:
+> 
+>        ```
+>        $ cmd /C 'set "GIT_USER=<Your GitHub username>" && yarn deploy'
+>        ```