Difference between revisions of "LESS"

Jump to: navigation, search
(Installing Recess under Mac OS X using MacPorts)
(The bootstrapbase theme)
 
(46 intermediate revisions by 14 users not shown)
Line 1: Line 1:
 
== Overview ==
 
== Overview ==
  
LESS extends CSS with dynamic behavior such as variables, mixins, operations and functions.  It's an advanced way of writing CSS that we use in some themes within Moodle.
+
LESS ([http://lesscss.org lesscss.org]) extends CSS with dynamic behavior such as variables, mixins, operations and functions.  It's an advanced way of writing CSS that we use in some themes within Moodle.
  
 
Browsers don't interpret it themselves, however, so LESS files need to be converted into normal CSS before use.
 
Browsers don't interpret it themselves, however, so LESS files need to be converted into normal CSS before use.
  
Recess is one tool used to compile and compress LESS into CSS under *nix based systems.
+
Recess is one tool used to compile and compress LESS into CSS under *nix based systems.  There are [https://github.com/cloudhead/less.js/wiki/GUI-compilers-that-use-LESS.js many others tools for LESS].
  
== The bootstrap theme ==
+
== The bootstrapbase theme ==
  
Moodle's bootstrap base theme has rules written using LESS.
+
Moodle's bootstrapbase theme has rules written using LESS.
  
The main LESS file is '''theme/bootstrap/less/moodle.less''', with additional files  in '''theme/bootstrap/less/moodle/''' imported by the main file.  
+
The main LESS file is '''theme/bootstrapbase/less/moodle.less''', with additional files  in '''theme/bootstrapbase/less/moodle/''' imported by the main file.  
  
After compiling the LESS files, CSS ends up in '''theme/bootstrap/style/generated.css'''.  This file should not be edited manually.
+
After compiling the LESS files, CSS ends up in '''theme/bootstrapbase/style/moodle.css'''.  This file should not be edited manually.
  
== Installing Recess under Ubuntu ==
+
== Compiling LESS  ==
The following commands should be run to install Recess
+
If you want to make changes to the .css generated from these .less files then you need to use a less compiler to build your changes. The supported way to achieve this
 +
is using '''grunt'''. (See [[Grunt]] for details of how to install it).
  
<pre>
+
After editing the LESS files, compile (minified) your CSS using '''grunt''' as follows:
sudo apt-get install npm node
 
npm install recess -g
 
</pre>
 
  
== Installing Recess under Mac OS X using MacPorts ==
+
<code bash>
1. Install MacPorts on Mac OS X. If you use a different package manager some install commands will vary.
+
$ grunt css
2. Install npm, the Node package manager
+
</code>
<pre>
 
    port install npm
 
</pre>
 
3. Install recess
 
<pre>
 
    npm install recess -g
 
</pre>
 
  
Depending on your shell, you may need to type rehash after installing for your shell to pick up the commands.
+
This will compile and compress the moodle.less & editor.less file (and all the LESS and CSS files it imports) into a single file, moodle.css & editor.css, and store it in the style folder of the bootstrapbase theme.
  
== Using Recess ==
+
== See also ==
 +
* [[Grunt]]
  
To compile to LESS for the boostrap theme use these commands, from the root of your Moodle code directory
+
[[Category:Themes]]
<pre>
 
cd theme/boostrap/less/
 
recess --compile --compress moodle.less > ../style/generated.css
 
</pre>
 
 
 
This will compile and compress the moodle.less file (and all the LESS and CSS files it imports) into a single file, generated.css, and store it in the style folder of the bootstrap theme.
 
 
 
NOTE: if you are getting empty generated.css files, this is being caused by a parsing error in your LESS code. You will need to examine what you have altered or written to make sure it is complete and the syntax is correct.
 
 
 
[[Category:Developer tools]]
 

Latest revision as of 07:12, 1 December 2016

Overview

LESS (lesscss.org) extends CSS with dynamic behavior such as variables, mixins, operations and functions. It's an advanced way of writing CSS that we use in some themes within Moodle.

Browsers don't interpret it themselves, however, so LESS files need to be converted into normal CSS before use.

Recess is one tool used to compile and compress LESS into CSS under *nix based systems. There are many others tools for LESS.

The bootstrapbase theme

Moodle's bootstrapbase theme has rules written using LESS.

The main LESS file is theme/bootstrapbase/less/moodle.less, with additional files in theme/bootstrapbase/less/moodle/ imported by the main file.

After compiling the LESS files, CSS ends up in theme/bootstrapbase/style/moodle.css. This file should not be edited manually.

Compiling LESS

If you want to make changes to the .css generated from these .less files then you need to use a less compiler to build your changes. The supported way to achieve this is using grunt. (See Grunt for details of how to install it).

After editing the LESS files, compile (minified) your CSS using grunt as follows:

$ grunt css

This will compile and compress the moodle.less & editor.less file (and all the LESS and CSS files it imports) into a single file, moodle.css & editor.css, and store it in the style folder of the bootstrapbase theme.

See also