govau/dta-gov-au-theme

此包已被放弃且不再维护。作者建议使用 govau/dta-gov-au 包。

dta.gov.au 的 Drupal 8 主题。

安装: 11

依赖: 0

建议者: 0

安全性: 0

星标: 7

关注者: 6

分支: 0

开放问题: 9

语言:CSS

类型:drupal-custom-theme

20.0.1 2020-07-15 23:55 UTC

This package is auto-updated.

Last update: 2022-12-02 07:46:24 UTC


README

dta.gov.au 的 Drupal 8 主题。

这是一个基于 DTA UI Kit Base Theme 的子主题。

需求

为了开发此主题,您需要

  1. 网站的本地副本 代码。请注意,网站无需运行即可开发主题,但如果您希望在本地测试更改,则需要运行一个网站。
  2. Composer.
  3. NPMNodeJS 版本 14。

如果您已遵循安装网站的说明,则应已在您的网站代码中拥有此主题的最新版本。如果没有,请确保将其克隆副本放入 docroot/themes/custom/dta-gov-au

安装必需文件

在主题文件夹内运行 npm i 以安装必需文件。

使用 Browser Sync 启动本地服务器

如果您正在运行本地版本,可以使用 Browser Sync 在您工作时自动查看代码更改。运行 npm run watch 以自动监视文件更改并在您操作时编译新的 CSS 文件。

CSS 更改将自动注入,JavaScript 和 Twig 更新将强制清除缓存并重置浏览器。

构建 CSS 文件

所有样式更改都是使用 SCSS 文件完成的,然后将其编译成一个单一的 CSS 文件。如果您正在向 SCSS 添加新模块,请遵循现有的文件夹和命名约定。

要构建 CSS 文件而无需运行本地服务器,请运行 npm run build

模板文件

网站中的大部分 HTML 都是通过 Twig 模板生成的。如果您需要调整 HTML 输出,请检查用于创建它的模板。这可以通过在本地启用 主题调试 来完成。然后,您可以选择更新模板(如果它在当前主题中存在,位于 templates 文件夹下)或复制调试注释中指示的模板文件(通过检查 HTML 来找到)并更新它。您可以通过使用调试系统指示的主题钩子来针对特定的模板。

有关模板系统的更多信息,请访问 Drupal 网站 进一步信息

请注意:一些模板可以通过基本主题获取。您可以通过此主题覆盖这些模板,或在那里进行更改。更新基本主题的说明大致相同(见下文)。

主题函数

如果您需要在Twig文件中添加新变量,或调整无法通过Twig完成的网站主题的其他方面,则可以使用.theme文件中的主题函数。有关主题函数的更多信息可以在Drupal网站上找到。

添加新的CSS或JavaScript文件

如果您需要添加新的CSS或JavaScript文件,请使用主题的.libraries.yml文件。有关添加库的更多信息可以在Drupal网站上找到。

部署更改

完成更改后,您可以使用Github和Circle CI将它们部署到预发布和生产站点。

  1. 为您的更改创建一个新的分支。
  2. 将这些更改提交到仓库并启动一个拉取请求。合并PR(目前尚未在主题上运行测试)。确保您包括构建的CSS文件,因为这不是远程执行的。
  3. 使用语义版本控制约定在Github上标记发布。本质上
    1. 对现有功能的修补或次要向后兼容更改增加了第三个数字,因此1.5.6 -> 1.5.7。
    2. 向后兼容功能的新更新增加了第二个数字,因此1.5.7 -> 1.6.0。
    3. 最后,主要、可能破坏API的更改增加了第一个数字,因此1.6.0 -> 2.0.0。
  4. 在网站根目录中,使用composer require新版本,例如,composer require govau/dta-gov-au:1.5.7。这将更新composer.jsoncomposer.lock文件。新版本在Packagist上可用和分发需要几分钟,因此新版本可能不会立即对Composer可用。
  5. 注意如果您更新了基本主题,您需要确保Composer了解这些更改。将 --with-dependencies添加到composer.lock中包括对基本主题的任何更改。请注意,基本主题仅作为此主题的依赖项包含,而不是在composer.json中。
  6. 然后,您可以按照https://github.com/govau/dta-website-rebuild/中描述的方式将这些更改部署到网站代码仓库。