You can make a local install (inside your application folder, so the package will be at
./node_modules) or a global one (with the
-g flag). With a global install you will need to make sure that the global installation folder is present at the
NODE_PATH env variable. A global install will also enable the Stylus command line interface.
You can clone Stylus git repository into
node commands and/or shells from the current directory will be able to find the cloned package.
Check your installation with
node -e "require('stylus')". It should print something like this and exit successfully.
The interaction is done by the
Stylus module. You can compile stylus syntax to CSS, convert it back, enable plugins and tweak some other options:
require 'stylus' # Accepts a raw string or an IO object (File, StringIO or anything that responds to 'read'). Stylus.compile(File.new('application.styl')) # returns the compiled stylesheet. # Using the compress option, removing most newlines from the code. Stylus.compile(File.read('application.styl'), :compress => true) # Or use the global compress flag Stylus.compress = true Stylus.compile(File.read('application.styl')) # Converting old and boring CSS to awesome Stylus. Stylus.convert(File.new('file.css')) # Importing plugins directly from Node.js, like nib. Stylus.use :nib # Enabling debug info, which sends the 'linenos' and 'firebug' options to Stylus. # If you provide a raw content String to the `Stylus.compile` method, remember to send # a `:filename` option so Stylus can locate your stylesheet for proper inspection. Stylus.debug = true
With the Rails 3.1 Asset Pipeline.
stylus to your Gemfile should let you work with
.styl files with the Rails 3.1 Pipeline. Any asset generated with
rails generate will be created with a
While Stylus has a
@import directive, inside a Rails application you should use the
//= require directive from Sprockets, so the caching mechanism will look after the changes made on the required file. If you're using mixins (for vendor prefixes or any common statements) or plugins inside your
.styl files, you should use Stylus
@import and Sprockets
//= depend_on. The latter is to ensure the proper dependency management on the Sprockets side.
.styl file on the Sprockets load path (
assets folder inside any other gem) will be available via the
config.assets.debug is turned on, Stylus will emit exta comments on your stylesheets to help debugging and inspection using the
firebug options. Check the FireStylus extension for Firebug for more info.
Stylus exposes a nice API to create plugins written on node.js, like nib. The installation process should be same as described above for Stylus (since they're all npm packages after all). You can hook them'up on your Ruby code with
Stylus.use :fingerprint, :literal => 'caa8c262e23268d2a7062c6217202343b84f472b'
Question, Bugs or Support
(The MIT License)
Copyright (c) 2011 Lucas Mazza <email@example.com>
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.