搜索中心
搜索中心 搜索快照

帮助文档标题 -

模块配置文件 config.json

配置文件是一个合法的JSON,请勿在JSON中包含注释,以下为了参数含义会在JSON中包含注释

{
    // 模块唯一标示,请使用 SomeExampleName 首字母大写的驼峰命名方式
    // 如果模块后期需要发布到模块市场,在开发前请先创建模块,防止与他人冲突
    "name": "Demo",
    // 模块文字说明
    "title": "开发示例程序",
    // 兼容环境,可选值为 laravel5、laravel9 ,默认为 laravel5
    "env": [
        "laravel5",
        "laravel9"
    ],
    // 模块类型,可以包含多个,目前支持以下值
    // PC:        电脑版
    // Mobile:    手机H5
    // App:       手机APP
    // MiniApp:   小程序
    // WxMiniApp: 微信小程序
    // Theme:     主题模块
    // Admin:     后台管理
    // Arch:      基础功能
    "types": [
        "PC",
        "Mobile"
    ],
    "tags": [
        "标签1",
        "标签2"
    ],
    // 当前模块版本号,请使用 主版本号.次版本号.修复版本号 的格式
    // 大的迭代请升级主版本号,常规次二代升级次版本号,Bug修复升级修复版本号
    "version": "1.2.0",
    // 模块依赖,支持多个
    "require": [
        // 依赖 Vendor 模块任何版本
        "Vendor",
        // 依赖 Abc 模块任何版本 
        "Abc:*",
        // 依赖 Abc 模块大于等于1.1.0的版本
        "Abc:>=1.1.0",
        // 依赖 Abc 模块大于1.1.0的版本
        "Abc:>1.1.0",
        // 依赖 Abc 模块小于等于1.1.0的版本 
        "Abc: 帮助文档使用帮助文档的文件名作为唯一标识,如果有更新会自动更新发布。

### 模块说明文档 content.md

文档位置位于 `Docs/module/content.md`

模块帮助文档位于 `Docs/module/content.md` ,使用模块开发助手后台上传模块时,会自动更新到模块说明文档中。

### 模块更新日志文档 release.md

文档位于 `Docs/release.md`

模块格式严格按照如下,使用模块开发助手后台上传模块时,会自动更新到模块发布更新日志中。

```md
## 1.1.0 版本发布说明

- 新增:XXX功能
- 新增:XXX功能
- 优化:XXX功能
- 修复:XXX功能

---

## 1.0.0 版本发布说明

- 新增:XXX功能
- 新增:XXX功能
- 优化:XXX功能
- 修复:XXX功能

多个版本使用 --- 分割。

查看原文
QQ
微信