X-lab-website

Beta version of xlab official website

Usage

Preparation

Firstly, you should make sure your local environment has Git and Node.js.

Then,you should fork this repo to your own account, and clone your fork:

# 1. fork this repo ti your own account

# 2. clone your fork repo 
git clone https://github.com/{your-own-account-name}/X-lab-website

# 3. add this repo as upstream
git remote add upstream https://github.com/X-lab2017/X-lab-website.git

Quick start

This section will introduce you how to start this project locally

# 1.make sure you have cloned the project into your local enivironment
git clone https://github.com/{your-own-account-name}/X-lab-website

# 2.default dir should be X-lab-website
cd X-lab-website

# 3.install deps
npm run install

# 4.start dev mode.
# This means that when you modify the source code or document content 
# and save it,you can see the effect in real time on the browser side
npm run start

Acknowledge

Special thanks to Docusaurus

License