shark2202 / docs

LogicFlow文档&示例

LogicFlow

文档开发

在docs目录下添加新的文档 文档预览： 先确保doscify已被全局安装 根目录下启动：yarn workspace docs serve 文档目录根目录下启动：docsify serve

示例开发

在examples目录下的examples中开发示例

1. 创建示例的集合目录，如场景案例（如果想要创建的集合已存在则跳过此步）
2. 创建具体的例子集目录，如业务场景、常有功能，并在该目录下修改或创建 config.json，如

{
  "name": "例子集-1-1",
  "key": "example-set-1-1",
  "examples": [
    {
      "name": "自定义带有图标的节点-1-1",
      "key": "custom-node-1-1",
      "mode": "playground", // playground 表示需要playground, 会跳转至playground页面， link 表示链接，会跳到外部链接（非playground页面）
      "github": "https://github.com/xxx" //github 地址，如果有
    },
    {
      "name": "使用vue自定义html节点-1-1",
      "key": "vue-1-1",
      "mode": "link",
      "link": "/demo/dist/vue-1-1", //一般是 /demo/dist/ + 项目夹名称（如vue-1-1)
      "github": "https://github.com/xxx" //github 地址，如果有
    }
  ]
}

具体参考项目已有的 config.json

3. 添加截图。开发完示例之后，如需使用自动截图工具（不保证其可用性，但可以试试不是嘛，帮我找找 BUG🐶）并自行安装相关依赖(有些依赖可能有点大，比如 puppeteer)，执行yarn dev:screenshot以自动生成截图，或者手动截图放在examples/src/screenshots中

4. 根目录下执行yarn build, 确保项目正常打包

开发完成后将开发分支的代码合并至master(必要时rebase master以保证master分支线性时间线)以部署项目github pages