{"id":19176616,"url":"https://github.com/sulu/suluthemebundle","last_synced_at":"2025-10-09T00:31:40.823Z","repository":{"id":45734040,"uuid":"59279345","full_name":"sulu/SuluThemeBundle","owner":"sulu","description":null,"archived":false,"fork":false,"pushed_at":"2024-07-24T15:19:47.000Z","size":71,"stargazers_count":18,"open_issues_count":3,"forks_count":15,"subscribers_count":10,"default_branch":"3.1","last_synced_at":"2025-01-19T20:09:46.128Z","etag":null,"topics":["php","sulu","sulu-bundle"],"latest_commit_sha":null,"homepage":"","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sulu.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2016-05-20T08:47:56.000Z","updated_at":"2024-08-25T06:17:17.000Z","dependencies_parsed_at":"2024-06-20T00:06:21.394Z","dependency_job_id":"9a1fbc66-2f23-4292-b4f7-a6ff63f0213f","html_url":"https://github.com/sulu/SuluThemeBundle","commit_stats":{"total_commits":47,"total_committers":15,"mean_commits":"3.1333333333333333","dds":0.7446808510638299,"last_synced_commit":"d08918569fe5cb261a16efa5f816fbe9f0153ee7"},"previous_names":[],"tags_count":20,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sulu%2FSuluThemeBundle","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sulu%2FSuluThemeBundle/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sulu%2FSuluThemeBundle/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sulu%2FSuluThemeBundle/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sulu","download_url":"https://codeload.github.com/sulu/SuluThemeBundle/tar.gz/refs/heads/3.1","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":235775564,"owners_count":19043182,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["php","sulu","sulu-bundle"],"created_at":"2024-11-09T10:29:16.723Z","updated_at":"2025-10-09T00:31:35.495Z","avatar_url":"https://github.com/sulu.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ch1 align=\"center\"\u003eSuluThemeBundle\u003c/h1\u003e\n\n\u003cp align=\"center\"\u003e\n    \u003ca href=\"https://sulu.io/\" target=\"_blank\"\u003e\n        \u003cimg width=\"30%\" src=\"https://sulu.io/uploads/media/800x/00/230-Official%20Bundle%20Seal.svg?v=2-6\u0026inline=1\" alt=\"Official Sulu Bundle Badge\"\u003e\n    \u003c/a\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n    \u003ca href=\"https://github.com/sulu/SuluThemeBundle/blob/3.x/LICENSE\" target=\"_blank\"\u003e\n        \u003cimg src=\"https://img.shields.io/github/license/sulu/SuluThemeBundle.svg\" alt=\"GitHub license\"\u003e\n    \u003c/a\u003e\n    \u003ca href=\"https://github.com/sulu/SuluThemeBundle/releases\" target=\"_blank\"\u003e\n        \u003cimg src=\"https://img.shields.io/github/tag/sulu/SuluThemeBundle.svg\" alt=\"GitHub tag (latest SemVer)\"\u003e\n    \u003c/a\u003e\n    \u003ca href=\"https://github.com/sulu/SuluThemeBundle/actions\" target=\"_blank\"\u003e\n        \u003cimg src=\"https://img.shields.io/github/workflow/status/sulu/SuluThemeBundle/Test%20application.svg?label=test-workflow\" alt=\"Test workflow status\"\u003e\n    \u003c/a\u003e\n    \u003ca href=\"https://github.com/sulu/sulu/releases\" target=\"_blank\"\u003e\n        \u003cimg src=\"https://img.shields.io/badge/sulu%20compatibility-%3E=2.0-52b6ca.svg\" alt=\"Sulu compatibility\"\u003e\n    \u003c/a\u003e\n\u003c/p\u003e\n\u003cbr/\u003e\n\nThe **SuluThemeBundle** provides the functionality to add multiple themes for different look and feel using multiple \nwebspaces in the [Sulu](https://sulu.io/) content management system. \n\nTo achieve this, the bundle uses the [SyliusThemeBundle](https://github.com/Sylius/SyliusThemeBundle) to render different\ntwig templates and asset files. Each webspace can have it's own theme.\n\n## 🚀\u0026nbsp; Installation and Usage\n\n### Install the bundle\n\nExecute the following [composer](https://getcomposer.org/) command to add the bundle to the dependencies of your \nproject:\n\n```bash\ncomposer require sulu/theme-bundle\n```\n\n### Enable the bundle \n\nEnable the bundle by adding it to the list of registered bundles in the `config/bundles.php` file of your project:\n\n```php\nreturn [\n    /* ... */\n    Sulu\\Bundle\\ThemeBundle\\SuluThemeBundle::class =\u003e ['all' =\u003e true],\n];\n```\n\n\n### Configure the SyliusThemeBundle\n\nIn order to use the bundle you have to add at least the following default configuration:\n\n```yaml\n# ./config/packages/sylius_theme.yaml\n\nsylius_theme:\n    sources:\n        filesystem: ~\n```\n\nBy default, the bundle seeks for the themes in the `%kernel.project_dir%/themes` directory and looks for a\ntheme configuration file named `composer.json`. This can be changed via the yaml configuration:\n\n```yaml\nsylius_theme:\n    sources:\n        filesystem:\n            filename: theme.json\n```\n\nFor more detailed information about the configuration sources go to the [SyliusThemeBundle documentation](https://github.com/Sylius/SyliusThemeBundle/blob/master/docs/configuration_sources.md).\n\n### Configure your themes\n\nEvery theme must have its own configuration file in form of a `theme.json`.\nGo to the [Theme Configuration Reference](https://github.com/Sylius/SyliusThemeBundle/blob/master/docs/theme_configuration_reference.md)\nfor the detailed documentation about the configuration options.\n\nThe minimal configuration for a theme would be the following:\n\n```json\n// ./themes/\u003ctheme-name-1\u003e/theme.json\n\n{\n  \"name\": \"vendor/\u003ctheme-name-1\u003e\"\n}\n```\n\nIt is important, that the `name` matches the naming convention of composer (`vendor/name`). \n\n### Create a theme\nFirst you have to create the directory `themes` inside your project.\nTo create a theme you have to create a new directory in the themes folder with the name of the new theme. \nIn the newly created directory you have to add the theme configuration file `theme.json`.\nSee [Configure your themes](#configure-your-themes). Additonally you have to create the `templates` directory next to \nthe `theme.json`. Afterwards you have to fill this folder with all the used templates and assets for this theme. \n\nThis results in the following project structure:\n\n```\nProjectName\n├── composer.json\n├── assets\n├── bin\n├── config\n├── templates\n├── themes\n│   ├── \u003ctheme-name-1\u003e\n│   │   ├── templates\n│   │   │   └── base.html.twig\n│   │   └── theme.json\n│   └── \u003ctheme-name-2\u003e\n│       ├── templates\n│       │   └── base.html.twig\n│       └── theme.json\n├── ...\n└── ...\n```\n\n### Add one of your themes to a webspace\n\nEach webspace can use a different theme. A theme can be enabled for a specific webspace by adding the theme name\n`\u003ctheme\u003evendor/theme-name\u003c/theme\u003e` to your webspace:\n\n```xml\n\u003c!-- ./config/webspaces/example.xml --\u003e\n\u003cwebspace xmlns=\"http://schemas.sulu.io/webspace/webspace\"\n          xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\"\n          xsi:schemaLocation=\"http://schemas.sulu.io/webspace/webspace http://schemas.sulu.io/webspace/webspace-1.1.xsd\"\u003e\n    \u003cname\u003eexample.com\u003c/name\u003e\n    \u003ckey\u003eexample\u003c/key\u003e\n    ...\n    \u003ctheme\u003evendor/theme-name\u003c/theme\u003e\n    ...    \n\u003c/webspace\u003e\n```\n\n## ❤️\u0026nbsp; Support and Contributions\n\nThe Sulu content management system is a **community-driven open source project** backed by various partner companies. \nWe are committed to a fully transparent development process and **highly appreciate any contributions**. \n\nIn case you have questions, we are happy to welcome you in our official [Slack channel](https://sulu.io/services-and-support).\nIf you found a bug or miss a specific feature, feel free to **file a new issue** with a respective title and description \non the the [sulu/SuluThemeBundle](https://github.com/sulu/SuluThemeBundle) repository.\n\n\n## 📘\u0026nbsp; License\n\nThe Sulu content management system is released under the under terms of the [MIT License](LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsulu%2Fsuluthemebundle","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsulu%2Fsuluthemebundle","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsulu%2Fsuluthemebundle/lists"}