AEM 站点主题构建器

这个寄存器包含用于构建站点主题的脚本,确保与AEM站点模板的要求相兼容. 建议整合"主题构建器"的方式是将其安装为"站点模板主题"的npm依赖. 这边 aem-site-theme-builder 命令可以在国家预防机制脚本中使用。 这种整合的例子可见于 标准站点模板。 。 。 .

安装

cd <your-site-theme>
npm install @adobe/aem-site-theme-builder --save-dev

使用量

代理服务器

代理您在 AEM 上运行的站点作为 Cloud Service 到本地主机, 用您本地编译的站点主题替换向站点主题提出的请求 .

npx aem-site-theme-builder proxy

网站主题的 URL 可以通过 .env 说明 环境变量。为了输入您本地编译的主题 编辑网站主题的位置 必须匹配.

现场预览

直播预览会运行代理服务器(上面被描述)以及浏览器同步功能. 浏览器同步将指向代理页面,并正在查找 dist 文件夹,每次有更改都会刷新页面.

npx aem-site-theme-builder live

主题 部署

1. 编译您的主题,并在GitHub上提供这些文物. AEM 作为云服务将尝试访问 https://api.github.com/repos/%GIT_ORG%/%GIT_REPO%/actions/artifacts/%GIT_ARTIFACT_ID%/zip 以便下载主题.
2. 执行 npx aem-site-theme-builder deploy 以更新AEM作为"云服务"的参考.

完成开发工作流程

为了充分利用主题构建器, 您必须运行提供代理和浏览器同步功能的活预览 。 除此之外,您还需要确保您的源文件有额外的监视器,该监视器将触发您的主题构建进程,该进程将产生修改 dist 文件夹。 通过浏览器同步刷新您的代理页面 .

API 密码

环境变量

主题构建器脚本基于您提供的环境变量. 这些变量用于正确提供AEM站点主题构建器的活性预览并部署功能.

以下是所需变量列表:

AEM_URL=<URL of the AEM as a Cloud Service instance>
AEM_SITE=<name of the AEM site>
AEM_PROXY_PORT=<localhost proxy server port>

以下是可选变量列表:

AEM_ADAPTIVE_FORM=<name of the AEM Form>

建议定义站点变量的方式是使用/创建 .env 在主题项目仓库中保存文件.

编译网站主题的预期输出

你可以随意使用你选择的任何建造工具. 唯一与"站点主题构建者"签订的合同是所编译的文物应当提供如下: 1

dist/
    css/
        theme.css
    js/
        theme.js
    resources/
        a-font.font
        an-image.png

发行和出版

运行"放出并发布"GitHub工作流程,提供您即将发布的语义版.

捐款

欢迎捐款! 读取 贡献指南 更多信息.

许可证发放

这个项目根据麻省理工学院的许可证获得许可。 见 自由主义 更多信息.