Docs

Getting Started with Koala

Koala is an open source GUI compiler for pre-processing languages. It currently supports Less, Sass, Compass, and CoffeeScript out of the box. It is cross-platform.

Features

• Multi-language Support: There is support for Less, Sass, CoffeeScript and the Compass framework.
• Real-time Compilation: Koala listens for file changes, and compiles them automatically when the file changes. Everything is running in the background without user action.
• Compile Options Support: You can set the compiler options for each file.
• Compression: Koala can automatically compress code after the compilation is completed.
• Error Notification: If Koala encountered an error during compilation, it will display the error message.
• Cross-platform: Koala can run on Windows, Mac and Linux.

Installation Guide

Download your system version of the installation package from the official website. Koala's built-in compiler components can be directly used after installation.

The Sass compiler function needs a system with Ruby installed. If you’re using OS X, you’ll already have Ruby installed. Koala has built-in Ruby on the Windows version.

Add project

Drag and drop a folder into the window to add a project, or click on the plus icon in the top left corner and select your project folder.

Change output path

By default, the output path is the file directory. If you want to change it, right-click on the file and select "Set output path". You can also click the edit icon near the output path.

Alternatively, you can set the output directory in the project configuration file; please refer to "Using project settings".

Batch file operations: set output path, compile, remove

Select multiple files first, and right-click on them to display the menu.

Use the mouse to select file elements, individually or in a group; ctrl(command) + a to select all.

Set the default compiler options

Open the settings window, find the language you use on the column, and select the compiler options you need. After saving, the new file will apply the settings.

These options can also be set in the project configuration file; please refer to "Using project settings".

Use custom compiler versions

Sometimes you need to use a custom version of the compiler, which you can set in 'Advanced Settings' of the compiler: Settings --> Sass/LESS --> Advanced Settings.

If you have installed the compiler on your system, you can just select "Use the system compiler" option. If not, you need to fill in the full path to the executable file.