Skip to content

sinoui/intellisense-form-website

Repository files navigation

智能表单产品站点

外网地址:http://sinoui.gitee.io/intellisense-form-website/

写文档

在写文档时,需要启动此站点项目:

# 第一次使用,需要安装依赖
$ yarn install
# 启动
$ yarn start

部署前环境准备

如果您是首次部署,可能需要对您的环境进行一些配置。

配置SSH公钥

部署命令需要您的仓库remote使用SSH协议,如果您已经进行了该配置可跳过本步骤。

$ git remote -v
origin  [email protected]:sinoui/intellisense-form-website.git (fetch)
origin  [email protected]:sinoui/intellisense-form-website.git (push)
  1. 本地生成SSH公钥

    如果本地已经有~/.ssh/id_rsa.pub文件了,可以跳过步骤。请参考生成/添加SSH公钥

    建议将公钥添加到个人设置 中,而不是具体某个仓库

  2. SSH公钥配置到gitee

    2.1 打开gitee个人设置 ,找到安全设置 => SSH公钥

    2.2 将第一步生成的公钥,复制到这里,点击确定即可。

  3. 添加完成之后,需要修改本地仓库remote地址

    git remote set-url origin [email protected]:sinoui/intellisense-form-website.git
  4. 验证配置是否生效

    git pull origin master
    

解决SSH不生效

  1. 如果使用已经有的公钥,请尝试重新生成SSH公钥
  2. 如果重新生成的公钥仍然不生效,可尝试升级GIT版本,下载window版本

部署文档(新)

配置

首先需要在环境变量中配置 GIT_USER 值,即你的gitee账号

然后在项目根目录添加 .dev.json 文件,添加以下配置:

{
  "gitee": {
    "userName": "登录gitee站点的用户名或者手机号",
    "password": "登录gitee站点的密码"
  },
  "browser": "edge"
}

如果不配置,则需要在命令行执行过程中输入 gitee 的登录名和密码。

browser指定一个(要打开gitee pages页面的)浏览器,支持edgechrome

如果您的系统为win10,可选择edge,否则选择chrome

  • edge程序的默认路径C:\Program Files (x86)\Microsoft\Edge\Application\msedge.exe
  • chrome的默认路径C:\Program Files\Google\Chrome\Application\chrome.exe

如果您的浏览器安装路径不是默认路径,browser需要指定具体的安装路径,例如:

{
  "gitee": {
    "userName": "登录gitee站点的用户名或者手机号",
    "password": "登录gitee站点的密码"
  },
  "browser": "C:\\Users\\Administrator.SINO-20170417UL\\AppData\\Local\\Google\\Chrome\\Application\\chrome.exe"
}

部署文档的命令

通过下面的命令行,即可部署文档:

$ yarn release

注意:部署文档过程中会自动打开 edge 浏览器,并加载 gitee page 页面。请不要关闭。

部署文档(旧)

文档编写完成后,就可以发布到外网。需要两个步骤完成文档部署:

第一步:发布文档

通过下面的命令行即可发布文档:

yarn cross-env GIT_USER=<你的gitee账号> USE_SSH=true docusaurus deploy

也可以在环境变量中配置 GIT_USER 值。配置完成后,即可通过下面的简单命令发布文档:

yarn deploy

第二步:在 gitee 上同步发布的文档

文档发布后,还需要在 gitee 上同步发布的文档。

首先打开: https://gitee.com/sinoui/intellisense-form-website/pages

然后点击页面中的更新按钮,完成同步,如下图所示:

同步发布的文档