Permalink
Browse files

Merge pull request #1069 from silvenon/iss-1017

Fix integration docs
  • Loading branch information...
2 parents 2793c2e + 080ef67 commit 192107cb4f17bef52fdd8c0d961fe77f3edb44c4 @scottdavis scottdavis committed Nov 2, 2012
Showing with 14 additions and 10 deletions.
  1. +14 −10 doc-src/content/help/tutorials/integration.markdown
@@ -28,44 +28,47 @@ Also checkout this [gist](https://gist.github.com/1184843)
require 'haml'
configure do
- set :haml, {:format => :html5, :escape_html => true}
+ set :haml, {:format => :html5}
set :scss, {:style => :compact, :debug_info => false}
Compass.add_project_configuration(File.join(Sinatra::Application.root, 'config', 'compass.rb'))
end
get '/stylesheets/:name.css' do
content_type 'text/css', :charset => 'utf-8'
- scss(:"stylesheets/#{params[:name]}" )
+ scss :"stylesheets/#{params[:name]}", Compass.sass_engine_options
end
get '/' do
haml :index
end
-If you keep your stylesheets in “views/stylesheets/” directory instead of just “views/”, remember to update sass_dir configuration accordingly.
+This assumes you keep your Compass config file in `config/compass.rb`. If you keep your stylesheets in “views/stylesheets/” directory instead of just “views/”, remember to update `sass_dir` configuration accordingly.
Check out this [sample compass-sinatra project](http://github.com/chriseppstein/compass-sinatra) to get up and running in no time!
[Sinatra Bootstrap](http://github.com/adamstac/sinatra-bootstrap) - a base Sinatra project with support for Haml, Sass, Compass, jQuery and more.
-## Nanoc3
+## nanoc
### Minimal integration: just drop it in
-One simple route for lightweight integration is to simply install compass inside nanoc. Then edit config.rb to point to the stylesheets you want to use. This means you have to have the Compass watch command running in a separate window from the Nanoc compilation process.
+One simple route for lightweight integration is to simply install compass inside nanoc. Then edit `config.rb` to point to the stylesheets you want to use. This means you have to have the Compass watch command running in a separate window from the Nanoc compilation process.
-Example project that works this way: http://github.com/unthinkingly/unthinkingly-blog
+Example project that works this way: [unthinkingly](http://github.com/unthinkingly/unthinkingly-blog).
### More formal integration
At the top of the Nanoc Rules file, load the Compass configuration, like this:
require 'compass'
- Compass.add_project_configuration 'compass.rb' # when using Compass > 0.10
- Compass.configuration.parse 'compass.rb' # when using Compass < 0.10
+ Compass.add_project_configuration 'compass.rb' # when using Compass > 0.10
+ sass_options = Compass.sass_engine_options # when using Compass > 0.10
-Your Compass configuration file (in compass/config.rb) could look like this (you may need to change the path to some directories depending on your directory structure):
+ Compass.configuration.parse 'compass.rb' # when using Compass < 0.10
+ sass_options = Compass.config.to_sass_engine_options # when using Compass < 0.10
+
+Then create a `compass.rb` file in your site's root folder and add your Compass configuration. An example configuration could look like this:
http_path = "/"
project_path = File.expand_path(File.join(File.dirname(__FILE__), '..'))
@@ -79,6 +82,7 @@ Your Compass configuration file (in compass/config.rb) could look like this (you
http_images_dir = "images"
http_fonts_dir = "fonts"
+You may need to change the path to some directories depending on your directory structure and the setup in your Rules file.
To filter the stylesheets using Sass and Compass, call the sass filter with Sass engine options taken from Compass, like this:
@@ -87,6 +91,6 @@ To filter the stylesheets using Sass and Compass, call the sass filter with Sass
end
-### Nanoc Projects using the formal approach
+### nanoc projects using the formal approach
* [This Site](https://github.com/chriseppstein/compass/tree/master/doc-src)

0 comments on commit 192107c

Please sign in to comment.