跳到主要内容

加入我们

只需几步,即可参与 VanSail 的贡献。

  1. 1

    安装 Z Shell(可选)

    /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
    brew install zsh
  2. 2

    安装 Git

    brew install git
  3. 3

    安装 Node.js

    前往 Node.js 官网下载页,选择你的操作系统与版本,按照命令或者下载安装包进行安装。
    推荐使用 Yarn 进行包管理。

  4. 4

    Fork 仓库

    点击 VanSail 项目主页,将本项目 Fork 到你的个人账号下。

  5. 5

    克隆源码

    将你的 Fork 克隆到本地:

    git clone https://github.com/<your-name>/VanSail.github.io.git
  6. 6

    安装依赖

    进入项目目录,安装所需依赖:

    cd VanSail.github.io
    yarn install
  7. 7

    启动开发预览

    启动本地开发服务器,实时热更新,用于边改边看效果:

    yarn start
  8. 8

    编译产物

    将源码编译为静态站点,产物输出到 build 目录:

    yarn build
  9. 9

    预览编译产物

    本地启动已编译的静态站点,用于正式发布前检查最终效果:

    yarn serve
  10. 10

    修改并发起 PR

    编辑代码后提交更改,向主仓库发起 Pull Request,等待评审合并。