Skip to content

squids-io/squids-docs

Repository files navigation

Squids Docs

Squids 文档中心,包含产品文档与产品博客

目录结构

  • docs: 存放所有的文档
  • blog: 存放所有的博客

环境依赖

补充

  • 为了便于在本机安装多个版本的 Node.js,可以安装工具 nvm(注意:win 系统好像无法安装)
  • 为了节省本地磁盘空间,可以安装工具 pnpm

安装项目依赖

$ npm install

本地开发

$ npm start

在浏览器打开 http://localhost:3000 地址预览查看

本地编译

$ npm build

生成 build 目录,可以部署到远端服务器

部署

Using SSH:

$ USE_SSH=true yarn deploy

Not using SSH:

$ GIT_USER=<Your GitHub username> yarn deploy

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the gh-pages branch.