openeuropa/oe_whitelabel

OpenEuropa 白标签主题。

安装次数: 17,205

依赖项: 0

建议者: 0

安全性: 0

星标: 2

关注者: 16

分支: 4

开放问题: 29

类型:drupal-theme

1.11.0 2024-09-20 15:48 UTC

This package is auto-updated.

Last update: 2024-09-20 15:51:51 UTC


README

OpenEuropa Bootstrap base theme 的子主题,具有为 OpenEuropa 库功能提供主题的功能。

功能

段落

以下段落尚未进行主题设计,因此不建议使用。

  • 上下文导航
  • 文档

有些段落被认为是“内部”的,仅适用于其他段落内部使用。

  • 列表项:在“列表项块”内用作列表项段落。
  • 事实:在“事实与数字”内用作列表项段落。

作为依赖项使用

网站项目可以使用 oe_whitelabel 作为活动主题,也可以创建一个以 oe_whitelabel 为基本主题的自定义主题。

要求

该软件包适用于使用 Composer 管理依赖项的 Drupal 项目。

理想情况下,该项目应使用 DockerDocker Compose 进行管理,但这不是强制要求。

请查看 composer.json 以获取所需的 PHP 版本和其他依赖项。

添加 composer 软件包

在 composer.json 中手动添加,或与现有条目合并

    "extra": {
        "artifacts": {
            "openeuropa/oe_bootstrap_theme": {
                "dist": {
                    "url": "https://github.com/{name}/releases/download/{pretty-version}/{project-name}-{pretty-version}.zip",
                    "type": "zip"
                }
            },
            "openeuropa/oe_whitelabel": {
                "dist": {
                    "url": "https://github.com/{name}/releases/download/{pretty-version}/{project-name}-{pretty-version}.zip",
                    "type": "zip"
                }
            }
        }
    }

由于此软件包目前处于 alpha 阶段,您需要在 composer 中进行额外步骤,以避免从已过时且不受支持的 0.x 分支获取任何内容。

一种选择是将 minimum-stability 设置为并要求 ^1.0 版本。您还应该将 prefer-stable 设置为减轻对其他依赖项的影响。当网站进入生产阶段时,请再次审查此设置。

composer config minimum-stability alpha
composer config prefer-stable true
composer require openeuropa/oe_whitelabel:^1.0

如果您不希望设置 minimum-stability,则需要为所有具有 alpha 版本的依赖项指定显式版本。

composer require openeuropa/oe_whitelabel:^1.0@alpha openeuropa/oe_bootstrap_theme:^1.0@alpha

审查已安装的软件包版本。

composer show -i | grep oe_

启用和配置

启用所需的和可选的子模块

# Always required.
./vendor/bin/drush en oe_whitelabel_helper

# Required, if you use oe_paragraphs module, or if you copied any paragraph
# types from that module.
./vendor/bin/drush en oe_whitelabel_paragraphs

# Other submodules are optional - check the /modules/ folder.
./vendor/bin/drush en <modulename>

启用主题并将其设置为默认值

./vendor/bin/drush config-set system.theme default oe_whitelabel

开发设置

使用 LAMP 栈或类似工具

这不受官方支持。您将自行负责。

使用 Docker Compose

或者,您可以使用提供的配置使用 DockerDocker Compose 构建开发网站。

Docker 提供了必要的服务和工具,如 Web 服务器和数据库服务器,以使网站运行,无论您的本地主机配置如何。

要求

配置

默认情况下,Docker Compose 读取两个文件,一个是 docker-compose.yml 文件,另一个是可选的 docker-compose.override.yml 文件。按照惯例,docker-compose.yml 包含您的基配置,并默认提供。重写文件,正如其名称所暗示的,可以包含现有服务或完全新服务的配置重写。如果服务在两个文件中都有定义,Docker Compose 将合并配置。

官方Docker Compose文档上查找更多关于Docker Compose扩展机制的信息。

启动容器

如果您有其他(以守护进程运行的)容器正在运行,您可能需要先停止它们

docker stop $(docker ps -q)

要启动,请运行

docker-compose up

建议不要将docker-compose守护化,这样您可以在工作完成后快速关闭(CTRL+C)。但是,如果您想将其守护化,您必须添加标志-d

docker-compose up -d

可选地清除现有安装

如果您已经安装了该软件包,并希望从头开始

docker-compose exec web rm composer.lock
docker-compose exec web rm -rf vendor/
docker-compose exec web rm -rf build/

安装软件包

docker-compose exec -u node node npm install
docker-compose exec -u node node npm run build
docker-compose exec web composer install
docker-compose exec web ./vendor/bin/run drupal:site-install

使用默认配置,开发站点的文件应在build目录中可用,并且开发站点可在以下位置访问:http://127.0.0.1:8080/buildhttp://web:8080/build

运行测试

运行grumphp检查

docker-compose exec web ./vendor/bin/grumphp run

运行phpunit测试

docker-compose exec web ./vendor/bin/phpunit

从旧版本升级

升级到1.0.0-alpha7

段落迁移

与段落相关的主题和功能已从OpenEuropa Bootstrap基础主题迁移到OpenEuropa Whitelabel

oe_bootstrap_theme_paragraphs中引入的特殊段落字段正在重命名为oe_whitelabel_paragraphs

如果您启用了oe_paragraphs模块,您应该在代码中创建一个hook_post_update_NAME(),以在部署期间启用oe_whitelabel_paragraphs模块。

function EXAMPLE_post_update_00001(): void {
  \Drupal::service('module_installer')->install(['oe_whitelabel_paragraphs']);
}

这是为了确保在部署期间,在配置导入之前安装钩子运行之前

请注意,drush updb还会触发oe_bootstrap_theme_helper中的更新钩子,这将卸载旧模块oe_bootstrap_theme_paragraphs

升级到1.0.0-alpha6

此版本包含一些错误,请直接切换到alpha7。