README

为dta.gov.au设计的Drupal 8主题。

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

要求

为了开发此主题，您需要

1. 网站的本地副本代码。注意，网站不需要运行来开发主题，但是如果您想在本地测试更改，则需要一个运行的网站。
2. Composer.
3. NPM和NodeJS版本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.json 和 composer.lock 文件。新版本在 Packagist 上可用和分发需要几分钟时间，因此新版本可能不会立即对 Composer 可用。
5. 注意如果您更新了基本主题，请确保 Composer 了解这些更改。向 composer.lock 中添加 --with-dependencies 以包含对基本主题的任何更改。请注意，基本主题仅作为此主题的依赖项包含，而不是在 composer.json 中。
6. 然后，您可以将这些更改部署到站点代码仓库，具体方法请参阅https://github.com/govau/dta-website-rebuild/。