https://github.com/oveleon/contao-theme-compiler-bundle

https://github.com/oveleon/contao-theme-compiler-bundle

compiler contao contao-bundle theme

Last synced: 22 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/oveleon/contao-theme-compiler-bundle
• Owner: oveleon
• License: mit
• Created: 2019-11-19T12:31:54.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2024-04-15T12:30:26.000Z (about 1 year ago)
• Last Synced: 2024-05-01T09:46:22.988Z (about 1 year ago)
• Topics: compiler, contao, contao-bundle, theme
• Language: PHP
• Homepage:
• Size: 72.3 KB
• Stars: 3
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Theme-Compiler

The contao theme compiler bundle adds the functionality to compile selected scss files within your theme settings.

+ [Features](#features)

+ [How to install](#how-to-install-the-package)

+ [Initial setup](#initial-setup)

+ [Console commands](#console-commands)

+ [Miscellaneous](#miscellaneous)

## Features

- Compiles your scss files in your contao installation

- A compile button next to your themes

- Able to add multiple source files

- Able to compile multiple files into one

- Enable backups for your compiled scss

## How to install the package

#### Via composer

```

composer require oveleon/contao-theme-compiler-bundle

```

#### Via contao-manager

```

Search for contao theme compiler bundle and add it to your extensions.

```

## Initial setup

1. Create a theme and add source file/s in your theme settings

2. Add a destination folder for your source files

3. (Optional settings for combining your files and more)

4. Save

   ![Admin View: Advanced form overview](https://www.oveleon.de/share/github-assets/contao-theme-compiler-bundle/themeSettings.jpg)

5. Compile in your theme-settings, within your theme overview, under maintenance or via console command

   ![Admin View: Advanced form overview](https://www.oveleon.de/share/github-assets/contao-theme-compiler-bundle/themeOverview.jpg)

   ![Admin View: Advanced form overview](https://www.oveleon.de/share/github-assets/contao-theme-compiler-bundle/maintenanceSettings.jpg)

   ```

   php vendor/bin/contao-console contao:themecompiler:compile [id]

   ```

## Console commands

### List themes

- Outputs a list of your themes within ``tl_theme``

```

php vendor/bin/contao-console contao:themecompiler:list

```

### Compile theme

- Compiles a theme ([id] is mandatory):

```

php vendor/bin/contao-console contao:themecompiler:compile [id]

```

## Miscellaneous

### Enable file sync on every compilation

Version 1.8 has been rewritten to skip the DBAFS sync if the files already exist. This saves a database call and logic

for each output file and improves compilation time.

To enable the old behaviour, use following in your config.yaml

```yaml

# config/config.yml

contao_theme_compiler:

  file_sync: true

```