govau / dta-gov-au-theme
Requires
- govau/dta-uikit-base: >=1.2.3
- dev-master
- 20.0.1
- 2.2.5
- 2.2.4
- 2.2.3
- 2.2.2
- 2.2.1
- 2.2.0
- 2.1.18
- 2.1.17
- 2.1.16
- 2.1.15
- 2.1.14
- 2.1.13
- 2.1.12
- 2.1.11
- 2.1.10
- 2.1.9
- 2.1.8
- 2.1.7
- 2.1.6
- 2.1.5
- 2.1.4
- 2.1.3
- 2.1.2
- 2.1.1
- 2.1.0
- 2.0.2
- 2.0.1
- 2.0.0
- 1.16.11
- 1.16.10
- 1.16.9
- 1.16.8
- 1.16.7
- 1.16.6
- 1.16.5
- 1.16.4
- 1.16.3
- 1.16.2
- 1.16.1
- 1.16.0
- 1.15.2
- 1.15.1
- 1.15.0
- 1.14.1
- 1.14.0
- 1.13.5
- 1.13.4
- 1.13.3
- 1.13.2
- 1.13.1
- 1.13.0
- 1.12.12
- 1.12.11
- 1.12.10
- 1.12.9
- 1.12.8
- 1.12.7
- 1.12.6
- 1.12.5
- 1.12.4
- 1.12.3
- 1.12.2
- 1.12.1
- 1.12.0
- 1.11.12
- 1.11.11
- 1.11.10
- 1.11.9
- 1.11.8
- 1.11.7
- 1.11.6
- 1.11.5
- 1.11.4
- 1.11.3
- 1.11.2
- 1.11.1
- 1.11.0
- 1.10.1
- 1.10
- 1.9.33
- 1.9.32
- 1.9.31
- 1.9.30
- 1.9.29
- 1.9.28
- 1.9.27
- 1.9.26
- 1.9.25
- 1.9.24
- 1.9.23
- 1.9.22
- 1.9.21
- 1.9.20
- 1.9.19
- 1.9.18
- 1.9.17
- 1.9.16
- 1.9.15
- 1.9.14
- 1.9.13
- 1.9.12
- 1.9.11
- 1.9.10
- 1.9.9
- 1.9.8
- 1.9.7
- 1.9.6
- 1.9.5
- 1.9.4
- 1.9.3
- 1.9.2
- 1.9.1
- 1.9
- 1.8.14
- 1.8.13
- 1.8.12
- 1.8.11
- 1.8.10
- 1.8.9
- 1.8.8
- 1.8.7
- 1.8.6
- 1.8.5
- 1.8.4
- 1.8.3
- 1.8.2
- 1.8.1
- 1.8.0
- 1.7.5
- 1.7.4
- 1.7.3
- 1.7.2
- 1.7.1
- 1.7.0
- 1.6.5
- 1.6.4
- 1.6.3
- 1.6.2
- 1.6.1
- 1.6.0
- 1.5.19
- 1.5.18
- 1.5.17
- 1.5.16
- 1.5.15
- 1.5.14
- 1.5.13
- 1.5.12
- 1.5.11
- 1.5.10
- 1.5.9
- 1.5.9-alpha2
- 1.5.9-alpha
- 1.5.8
- 1.5.7
- 1.5.6
- 1.5.5
- 1.5.4
- 1.5.3
- 1.5.2
- 1.5.1
- v1.5.0
- 1.4.0
- 1.3.0
- 1.2.3
- 1.2.2
- 1.2.1
- 1.2.0
- 1.1.4
- 1.1.3
- 1.1.2
- 1.1.1
- 1.1.0
- 1.0.4
- 1.0.3
- 1.0.2
- 1.0.1
- 1.0.0
- dev-dependabot/npm_and_yarn/decode-uri-component-0.2.2
- dev-dependabot/npm_and_yarn/engine.io-and-browser-sync-6.2.1
- dev-dependabot/npm_and_yarn/socket.io-parser-and-browser-sync-4.2.1
- dev-dependabot/npm_and_yarn/css-what-2.1.3
- dev-dependabot/npm_and_yarn/shell-quote-1.7.3
- dev-dependabot/npm_and_yarn/node-sass-7.0.0
- dev-aga-content
- dev-form-id-update
- dev-cards-fix
- dev-dependabot/npm_and_yarn/lodash-4.17.21
- dev-dependabot/npm_and_yarn/ua-parser-js-0.7.28
- dev-dashboard-year-2-cards
- dev-dependabot/npm_and_yarn/bl-1.2.3
- dev-Patch-for-modal
- dev-Issue-796---Link-website-requests-directly-with-Zendesk-form
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 的子主题。
需求
为了开发此主题,您需要
如果您已遵循安装网站的说明,则应已在您的网站代码中拥有此主题的最新版本。如果没有,请确保将其克隆副本放入 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将它们部署到预发布和生产站点。
- 为您的更改创建一个新的分支。
- 将这些更改提交到仓库并启动一个拉取请求。合并PR(目前尚未在主题上运行测试)。确保您包括构建的CSS文件,因为这不是远程执行的。
- 使用语义版本控制约定在Github上标记发布。本质上
- 对现有功能的修补或次要向后兼容更改增加了第三个数字,因此1.5.6 -> 1.5.7。
- 向后兼容功能的新更新增加了第二个数字,因此1.5.7 -> 1.6.0。
- 最后,主要、可能破坏API的更改增加了第一个数字,因此1.6.0 -> 2.0.0。
- 在网站根目录中,使用
composer require
新版本,例如,composer require govau/dta-gov-au:1.5.7
。这将更新composer.json
和composer.lock
文件。新版本在Packagist上可用和分发需要几分钟,因此新版本可能不会立即对Composer可用。 - 注意如果您更新了基本主题,您需要确保Composer了解这些更改。将
--with-dependencies
添加到composer.lock
中包括对基本主题的任何更改。请注意,基本主题仅作为此主题的依赖项包含,而不是在composer.json
中。 - 然后,您可以按照https://github.com/govau/dta-website-rebuild/中描述的方式将这些更改部署到网站代码仓库。