编辑器

如果您希望为本项目的无代码网页编辑器贡献内容或代码,请参阅此文档

目录

相关链接

如何添加新的组件

Silex允许我们通过配置文件client-config.js为编辑器添加新的组件和块。 组件和块的具体添加方式请参照GrapesJS文档

config.on('silex:startup:end', () => {
        const editor = config.getEditor()
        //whatever your block is
        }

如何添加新的插件

与组件类似,我们也可以通过配置文件client-config.js为编辑器添加新的GrapesJS插件

例如:

import 'https://unpkg.com/grapesjs-navbar'
//....rest part of the config
config.on('silex:grapesjs:start', () => {
        const grapesjsNavbar = window['grapesjs-navbar']
        config.grapesJsConfig.plugins = [
            ...config.grapesJsConfig.plugins,
            'grapesjs-navbar',
        ]
    })

贡献代码

如果您希望为我们贡献代码,请遵循以下步骤

注意,以下出现的所有<>并不是代码的一部分,它只是用来告诉您应该修改哪里,因此在您修改完成后请删除他们

以下操作默认您有安装Git以及Node.js

IntelliJ IDEA为学生提供免费版本,推荐使用。

  1. 分叉(Fork)项目

    在GitHub中打开 JeremyZXi/KeyCAS,点击右上角的 Fork。这会将该项目添加到您的账户中的副本。

  2. 克隆项目

    您需要一个本地副本(通过命令行)

    # 打开命令行工具/终端
    # 进入您希望使用的路径(这步可省略)
    cd <your-desired-working-directory>
    git clone https://github.com/<您的用户名>/KeyCAS.git
    
  3. 设置上游仓库

    请将 JeremyZXi/KeyCAS 设置为上游仓库,以便您提交代码(执行 pull request)

    cd KeyCAS
    git remote add upstream https://github.com/JeremyZXi/KeyCAS.git
    
  4. 创建一个新的分支

    这步可以省略,但是保持分支是个好习惯

    创建您的分支

    git checkout -b <new-branch-name>
    

    然后设置分支的上游仓库

    git branch --set-upstream-to=dev <new-branch-name>
    
  5. 安装依赖

    请确保您的Node版本 >= 18

    npm install
    
  6. 修改

    在您完成修改或添加内容之后,您需要提交一个 commit

    如果您使用 IntelliJ IDEA 则可以使用其左上角的图形化界面提交

    git commit -m "This is a short message about the change made in this commit"
    
  7. 提交

    提交您的代码

    git push origin <branch-name>
    
  8. 创建一个 pull request

    创建您的 pull request,请尽量确保标题简洁易懂