SASS and Zurb Foundation - confusing installation instructions - css

I decided to use the Sass version of Foundation4 as the CSS one is virtually impossible to edit efficiently now.
I followed the instructions here: http://foundation.zurb.com/docs/sass.html
These advised me to install the gem (no problem) then install compass then create a project, which I did in wwwroot.
All good so far. It then goes on to advise me to "download the files from Github (grab the scss/ and js/ directories) and put them into your project directory"
Now why in the name of a fish on a bicycle would the instructions advise me to do this when the previous step on the command line (compass create -r zurb-foundation --using foundation) creates a folder already in the root directory for my project - albeit named differently - that contain similar if not identical files? There's already a "javascripts" folder with "foundation" and "vendor" subfolders that contain largely the same files - although some are different sizes.
Am I missing something? The included "index.html" file reference the "javascripts" folder so why am I meant to be including "js" from the github? This is very confusing when you're new to the technology!
After following the installation instructions I now have "foundation.scss" and "app.scss" files which seem to be largely the same apart from one (app.scss) has lots commented out. Which one am I meant to use?
It seems to me that the instructions are basically out of date. It appears that I don't need "js" from github but I do need "scss". The contents of this scss folder look like they need to go into the "sass" folder created when the project is made and the "foundation.scss" file can be deleted as "app.scss" is a copy of it.
I have no idea where the base "app.scss" file is hoping to "#import foundation" from as there is no "foundation" folder created on installation/creation of project. Maybe I'm missing something but it's all very confusing. Could someone please clarify what I need to start with and what I can delete/ignore?

When you install the gem, all the proper Foundation files are installed for you in the gem cache. Compass will pull all the F4 SCSS files into your project via the #import directive from foundation.scss.
The project docs in the Github repo show the latest Compass instructions for building your F4 project.
https://github.com/zurb/foundation/blob/master/docs/sass.html.erb
It sounds like you are mixing the Standalone instructions into the Compass ones.
If you have run this:
[sudo] gem install compass
cd path/to/where-you-want-your-project
run compass create <project-name> -r zurb-foundation --using foundation
You don't need Github or the Standalone instructions.
The steps below outline the manual steps of building an F4 project. I think you're stuck on STEP 4, so focus on that part.
STEP 1:
Download for easy access these two archives:
Foundation Vanilla:
http://foundation.zurb.com/files/foundation-4.1.6.zip
Foundation Master:
https://github.com/zurb/foundation/archive/master.zip
CD into your www root directory:
STEP 2:
Create this file:
/config.rb
require 'zurb-foundation'
http_path = "/"
css_dir = "css"
sass_dir = "scss"
images_dir = "img"
javascripts_dir = "js"
output_style = :expanded
relative_assets = true
line_comments = true
Switch output_style = :compact or :compressed and line_comments = false for Production (when going live).
STEP 3:
Copy/Move index.html from Foundation Vanilla into your root www directory.
Edit line 11 and change foundation.css to app.css in the style tag.
STEP 4:
Create this directory and file:
/scss/
Create app.scss - This is your site/app stylesheet and we'll import Normalize and F4 in it.
Copy this into it:
// Global Foundation Settings
// #import "settings";
// Comment out this import if you don't want to use normalize
#import "normalize";
// Comment out this import if you are customizing you imports below
#import "foundation";
// Your own SCSS here...
If you want to override some F4 SaSS variables you will need the _settings.scss file. For now I would skip this step and leave it commented out until you are more familiar with F4.
STEP 5:
Create this directory (files automatically written here):
/css/
app.css - will be written here from /scss/app.scss by Compass. Normalize and all the F4 CSS will be inside it, plus any of your own CSS you've added.
This happens automatically, you don't need to do anything except have the required gems installed and your Compass config file from STEP 2.
STEP 6:
Create this directory and copy/move these files into it:
/js/
Copy/Move /js/foundation.min.js from the Foundation Vanilla download here.
If you need your own app.js create/place it here and link to it last in your footer.
/js/vendor/
Copy/Move /js/vendor/custom.modernizr.js from the Foundation Vanilla download into here.
Copy/Move /js/vendor/zepto.js and /js/vendor/jquery.js from the Foundation Vanilla download here.
Later, when you feel more comfortable, you can cherry pick individual Foundation JS files from Foundation Master and concatenate them into a smaller lib here as foundation.min.js.
That should do it.
Check out this file in my www repo, as it shows a working F4 setup:
https://github.com/jhauraw/jhaurawachsman.com/blob/master/_layouts/default.html
You can also poke around there for how to integrate Grunt.js for automated build of the SCSS and JS with concatenation and minification:
https://github.com/jhauraw/jhaurawachsman.com/blob/master/Gruntfile.js

Without being as adept as #jhauraw, I did notice something else.
I installed FOundation through the Compass app. Being a novice with Compass, I too was looking for the "foundation" folder that would contain all the various Foundation SCSS files. And when I looked at the _settings.scss file that was present, it appeared that everything was commented out. What I know understand (still as a novice towards Compass) is that the "foundation" file lives within a resource library within Compass. When needed, these files are imported when generating the CSS file. The _settings.scss file with all the commented out fields is an override file. So if you remove the comments for a particular variable or mixin, it will override the originals hidden in the Compass library. The compiled CSS seems to contain everything that's needed.

Related

How to compile SASS .scss files in most basic method (without framework)

I installed Bootstrap CSS with SASS from the following repo:
https://github.com/twbs/bootstrap-sass
I ran the command "bower install bootstrap-sass" on the command line and this successfully installed the folder bower_components on my project folder. (Incidentally - I have nothing else present yet, I want to learn to bootstrap the CSS compiling first).
OK, here's what I want to accomplish:
I want to be able to add .scss files to the folder I create called resources/assets/sass/
I want to provision/manage so that .scss files I add to this directory are in turn compiled to public/build/css/that_file_name.css
More practically, I would like to compile all of the .scss files into one large .css file.
My question(s) are:
What does the compiling?
How do I instruct it to compile the .scss files in the folder above in the public/build/css/ folder?
Must I configure new .scss files or can I set it so as to just add them to that sass folder?
Bonus, how do I tell it to minify the output file, or not (so I can experiment with both ways)?
What does the compiling?
Compiling Sass files transforms stylesheets with Sass-specific syntax like selector nesting and mixins into normal CSS that can be parsed by browsers.
How do I instruct it to compile the .scss files in the folder above in the public/build/css/ folder?
Since you're already using Bower which is a Node.js package, I assume that you have no problem using the Node.js package node-sass instead of the original Ruby version.
First, install the package using npm i -D node-sass. Then, create a new script inside your project's package.json:
"compile-sass": "node-sass resources/assets/sass/main.scss public/build/css/main.css"
main.scss is now your entry point where you import Bootstrap and your other stylesheets.
// I don't know whether this path is correct
// Just find out the location of "_bootstrap.scss" and then create the relative path
#import "../../../bower_components/bootstrap-sass/assets/stylesheets/_bootstrap.scss";
/* Your custom SCSS */
Finally, to actually run the compilation, execute npm run compile-sass in your terminal.
Must I configure new .scss files or can I set it so as to just add them to that sass folder?
Since you never tell node-sass to "compile everything inside this folder" and instead use an entry point file (main.js), when you want to include a new file you simply add an #import directive with a relative path to it.
Bonus, how do I tell it to minify the output file, or not (so I can experiment with both ways)?
To minify the resulting main.css file, I recommend csso. You can install its CLI package using npm i -D csso-cli and then add another script to your package.json:
"minify-css": "csso public/build/css/main.css public/build/css/main.min.css"
You can then run that script using npm run minify-css. The minified file will be outputted as main.min.css.
For all the question asked, the answer can be found above. But if you are just looking to compile .scss file to .css using command line, use below,
sass source/stylesheets/index.scss build/stylesheets/index.css
Make sure you have "node JS/npm" and Sass compiler installed.
If not, use this to install Node.js and npm - https://www.npmjs.com/get-npm
And use this to install Sass - https://sass-lang.com/install
Enjoy ;)

How to manually install Zurb Foundation?

I'm trying to follow the Zurb Foundation "manually installation".
According to the instructions:
First you will need to clone or download the master zip of the
Foundation Compass Template from Github. This will be the root of
your project.
Then you will create a directory called bower_components.
The next step is to clone or download the master zip of the
bower-foundation repo in that directory.
Then rename this directory to "foundation".
And then it says that the filelist should be like this after following all the instructions:
bower_components (folder)
js (folder)
app.js
scss (folder)
_settings.scss
app.scss
stylesheets (folder)
app.css
bower.json
config.rb
humans.txt
index.html
robots.txt
Now, I'm probably missing something really silly here, but there's no way that following those instructions I get that file structure.
For a starter, there's no .rb file, and bower-foundation has a foundation and vendor folders inside the js folder! And how about the spec folder that's inside the foundation-master zip file? And you get more than one scss folder.
So, maybe I'm somewhat burnout and don't quite understand the instructions properly?
Just in case anyone out there happens to bump into the same issue, I've solved it following their video instructions to do it with the CLI (using the command line).
After doing it (it's pretty fast and straightforward), I can confirm that their "manual instructions" are NOT correct, so please, up until they update them you should NOT use those instructions.

Foundation basics, scss, js and bower components

Can I compile scss from project folder created with foundation new project with sass?
Why js folder had only app.js file, should I move files from bower_components/foundation/jsto (root)/js or link to their folder?
Should user css settings includes in app.css or custom file that includes app.css?
In bootstrap sass files collected in one folder, why in foundation scss folder had only app.scss and other files in bower components.
When you install Foundation this way, you use the SCSS folder created that contains the _settings.scss & app.scss. The app.scss is what you tend to use as your base SCSS file to compile from so you'd include all your other SCSS files to this one. You can move this file to elsewhere if you please but move the config.rb with it and make sure the add_import_path works from where you move it to.
You don't need to move the files, everything in bower_components should never be touched or moved, they are there so they can be upgraded when necessary, you shouldn't have to touch base Foundation files.
I said before you should use that, but you could include the app.scss into a custom scss file but it's better to have control of the Foundation imports in 1 file, in my opinion.
For the same reason i mentioned in 2, so you don't touch them and Bower can easily update them if you require.

Foundation 5 project setup with SASS

I'm pretty new to the whole world of Compass and SASS, so I might be missing something fundamental here. I'm running into a structuring problem with Foundation 5.
How does one get this all to work neatly within an existing (git) project?
When I run foundation new myproject, it clones the basics into 'myproject': a bower_components/ folder for the dependencies, a config.rb in the root, an 'scss' folder where I can modify the SASS files with compass watch running in the background to generate my CSS files, and an example index.html file. On its own, I think I get how it all works.
I have an existing project in which I intend to use Foundation 5. My first instinct was to try to "initialize" Foundation in the root of my project: foundation new .
Since it's using git, of course it complained the dir wasn't empty. Fair enough, so I made it a sub-folder within my public_html: foundation new foundation. I placed config.rb in the root of my project and updated the paths, so I can just run compass watch from my root. All this worked pretty neatly, I played around with the scss files and watched my css file get updated accordingly. Then I committed the result and pulled it from a different location. 'foundation', being a repo inside of a repo, didn't get committed along with everything else. Most of the stuff inside there doesn't matter - foundation new whatever loads it all up again, and .gitignoring /bower_components is sensible. But the custom code inside the 'scss' directory I do need. I tried setting up my project in a different way, having the 'scss' dir outside of the bower directory, and setting it as the sass_dir in config.rb.
That setup makes sense to me, but I can't get it to work: running compass watch fails:
File to import not found or unreadable: foundation.
My config.rb right now:
http_path = "/"
css_dir = "public_html/assets/css"
sass_dir = "foundation/scss"
images_dir = "public_html/assets/img"
javascripts_dir = "public_html/assets/js"
How do I tell it explicitly where foundation is? I've tried playing around with 'add_import_path' in config.rb, but that didn't do much.
I have the feeling I'm missing something fundamental here, or maybe I'm overthinking it. Google isn't helping much since Foundation 5 is pretty much fresh out of the oven. Can somebody give me a push in the right direction?
Thanks!
I had a similar problem, I ended up downloading foundation-compass-template instead of using the foundation command line
Unzipping it into the root of my project and then
bower install
Here is the config.rb that came along with it:
# Require any additional compass plugins here.
add_import_path "bower_components/foundation/scss"
# Set this to the root of your project when deployed:
http_path = "/"
css_dir = "stylesheets"
sass_dir = "scss"
images_dir = "images"
javascripts_dir = "javascripts"
I know it's not a direct answer but hopefully that project gives you a some direction
Hope this helps
The accepted answer turned out to be part of the solution. It worked, and looking at the config.rb again I realized the right way to tell Compass where to look for Foundation. D'oh.
My structure is now as follows:
config.rb
public_html/
--assets/
----scss/
----css/
----foundation/
------bower_components/
--------foundation/
----------scss/ # this is the dir that needed to be imported from config.rb
Config.rb:
add_import_path "public_html/assets/foundation/bower_components/foundation/scss" # *magic*
http_path = "/"
css_dir = "public_html/assets/css"
sass_dir = "public_html/assets/scss"
images_dir = "public_html/assets/img"
javascripts_dir = "public_html/assets/foundation/js"
As you can see, this way things are exactly like what I was hoping to get: Foundation's stuff inside of public_html/assets/foundation - don't need to touch that directory for anything except running bower update from time to time - and my custom scss resides in public_html/assets/scss.
Thanks for giving me that much-needed push!

How to specify correct output folder for CSS using SASS & LiveReload?

Having a strange problem.
I'm using SASS, I have compass installed, but don't need to use it because I have LiveReload.
With LiveReload I've pasted the script into my index2.html file. Then in Output Paths I have my sass/main.scss folder targeted to the css/main.css folder. However for some reason it still outputs to a stylesheet folder.
This is driving me nuts, how do I force SASS or lifereload to make sure I'm outputting to the correct folder? I never created the stylesheets folder and when I deleted and make a change and save my main.scss file it recreates the stylesheets folder and puts main.css inside that X_X
Edit: I believe it is a config file somewhere in this python project. I Found a config.rb file, but path seems fine there, so it must be another setting somewhere... I'm going to keep looking, or I could ask the Python dev Monday
config.rb
# Require any additional compass plugins here.
require 'compass/util'
require 'compass/browser_support'
require 'compass/sass_extensions'
require 'compass/version'
require 'compass/errors'
require 'compass_twitter_bootstrap'
require 'breakpoint'
require 'toolkit'
# Set this to the root of your project when deployed:
http_path = "/"
css_dir = "css"
sass_dir = "sass"
images_dir = "img"
javascripts_dir = "scripts/js"
environment = :production
output_style = (environment == :production) ? :compressed : :expanded
The problem was how it was setup by the previous developer, not that he was causing a bug, it was just the way he had it setup.
I created a new folder and moved my files there and now my SCSS files in the SASS folder does compile correctly into the CSS folder.
Just change your link to your css with the appropriate styles folder you speak of. Wouldn't that be just as quick of a solution?

Resources