Skip to content
Ethan Lai edited this page Jul 4, 2013 · 38 revisions

Here is the wiki of Koala. 中文Wiki >>

Docs

Getting Started with Koala

Koala is a open source gui compiler for preprocessing languages, currently support Less, Sass, Compass, CoffeeScript, out of the box and cross-platform.

Features

  • Multi-language Support: support for Less,Sass, CoffeeScript and Compass Framework.
  • Real-time Compilation: listening files, compile automatically when the file changes, that everything is running in the background without user action.
  • Compile Options Support: you can set the compiler options for each file.
  • Compression: auto compress code after compilation is completed.
  • Error Notification: if encountered an error during compilation, koala will pop up the error message.
  • Cross-platform: koala can run in Windows, Mac and Linux.

Installation Guide

Download your system version of the installation package in official website, Koala built-in compiler components, can be directly use after installation.
The Sass compiled function need system has been installed ruby. If you’re using OS X, you’ll already have Ruby installed. Windows users can install Ruby via the Windows installer, and Linux users can install it via their package manager.
For windows user, you need to check on the option "Add Ruby executables to your Path".
ruby-install

Set ruby PATH system variable on windows

On Windows you need to set your system PATH variable (My Computer -> Properties -> Advanced -> Environment Variables -> System variables)
If installed ruby in c:\ruby, append the PATH Variable value: c:\ruby\bin;
See the docs here: http://www.tutorialspoint.com/ruby/ruby_installation_windows.htm.

Add project

Drag and drop a folder into the window to add project, or click 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.
You can also set 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, 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, select the compiler options you need.After setting, the new file will apply the settings.
You 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, you can set in the general settings. Just select the language you use under "Use System Libs". It requires that you have installed the compiler libs, and can be directly compile command such as "lessc", "sass" in the terminal.
use-system-libs