跳到主要内容

🛠 开发准备工作

emlog支持模板主题和扩展插件，开发者可以开发个性化的模板主题以及功能插件，来丰富emlog站点的功能和样式。

开发环境​

  • PHP7.4及以上
  • MySQL 5.6 及以上版本
  • 浏览器需适配：Chrome
  • 代码仓库推荐：Gitee 或者 GitHub

配置开发环境​

  • Windows 系统：本地开发集成环境推荐：phpEnv
  • Mac 系统：推荐使用 docker-compose 方式启动开发环境

其他工具​

编辑器

  • trae ，有条件的推荐使用国际版
  • vscode

AI 工具

  • kimi
  • 豆包 图像生成功能可以协助做图

打包工具（避免将隐藏文件打包，如：.git 等）

开发规范​

开启开发者模式​

在根目录 config.php 文件末尾追加一行配置，如下：

const ENVIRONMENT = 'develop';

配置后程序将输出更详细的报错信息，包括 warning 和 notice 级别的错误，方便调试完善代码。 请消灭所有 warning 和 notice 报错（大部分是未初始化的变量，或者未判断变量的异常情况引起的）。

开发文档​

Agent Skill​

为了方便为 AI 开发，我们提供应用开发 Agent Skill：

上架规范​

通用规范​

  1. 应用必须适配 PHP7.4 及 8.1 两个版本。
  2. 移植作品请注明原作者，未特别注明的均视为开发者原创，如有侵权行为开发者需要负相关责任。
  3. 应用不得修改核心数据库表及字段，包括向核心表增加字段，更不能添加没有默认值的字段。
  4. 应用关闭或者删除后不得影响站点正常功能。
  5. 开启开发者模式，解决所有 warning 及 notice 报错。

模板审核规范​

  • 模板需要包含模板开发文档中提到的核心插件挂载点，详见:模板开发文档
  • 安装包内主题封面（preview.jpg）尺寸： 500x300

插件审核规范​

  • 插件设置界输入框、按钮等样式要和后台界面风格保持风格一致、无明显页面错乱。
  • 插件不得影响后台的样式，不在左侧边栏等额外增加插件设置界面的菜单入口。
  • 避免简单模仿或聚合商店已有插件的功能
  • 避免直接操作 $_GET 和 $_POST 数组，采用核心的 Input 类来获取参数，详见：系统调用和通用函数
  • 避免使用文件来存储插件设置，使用系统提供的 Storage 类来存储插件设置，详见：插件开发文档
  • 安装包内插件图标（preview.jpg）尺寸： 75x75

应用商店封面图规范​

  • 模板封面图：尺寸 500x300，禁止包含任何宣传广告文字、边框装饰等，仅内容填充完整的模板预览图即可。
  • 插件封面图：尺寸 500x300，禁止在封面上出现中文，包括直接大字体插件名称、高饱和度纯色背景、等简单粗暴的封面设计。

AI 生成插件封面图提示词推荐：

为插件：xxxxxxx 设计一款封面，要求： 1、扁平化设计风格，封面清爽干净，尽可能少的元素，避免元素过多， 2、不使用任何文字元素 3、不使用装饰图案和杂乱背景，用合适的图标作为主元素 4、尺寸： 500 * 300 px

应用发布​

应用下架​

我们鼓励活跃的开发者，不断改进维护自己的应用，也会定期清理一些已经疏于维护的应用。

  • 超过2年未更新的收费应用可能会被下架
  • 用户反馈得不到及时回复的收费应用可能会被下架
  • 免费应用不对活跃情况做具体要求，但是如果问题很多不及时解决也可能被下架。