Jekyll Sass Converter
Let Jekyll build your Sass and SCSS!
Jekyll Sass Converter requires Jekyll 2.0.0 or greater and is bundled with Jekyll so you don't need to install it if you're already using Jekyll.
Add this line to your application's Gemfile:
And then execute:
Or install it yourself as:
$ gem install jekyll-sass-converter
Jekyll Sass Converter comes bundled with Jekyll 2.0.0 and greater. For more information about usage, visit the Jekyll Assets Documentation page.
v3.0, Jekyll Sass Converter uses
sass-embedded for Sass implmentation.
Please see migrate from 2.x to 3.x for more information.
v2.0, the Converter will by default generate a source map file along with
.css output file. The source map is useful when we use the web developers tools of
Firefox to debug our
The source map is a file that maps from the output
.css file to the original source
.scss style sheets. Thus enabling the browser to reconstruct the original source
and present the reconstructed original in the debugger.
Configuration options are specified in the
_config.yml file in the following way:
sass: <option_name1>: <option_value1> <option_name2>: <option_value2>
Available options are:
Sets the style of the CSS-output. Can be
expanded. See the SASS_REFERENCE for details.
A filesystem-path which should be searched for Sass partials.
An array of additional filesystem-paths which should be searched for Sass partials.
Controls when source maps shall be generated.
never— causes no source maps to be generated at all.
always— source maps will always be generated.
development— source maps will only be generated if the site is in development environment. That is, when the environment variable
JEKYLL_ENVis set to
Migrate from 2.x to 3.x
Classic GitHub Pages experience still uses 1.x version of jekyll-sass-converter.
To use latest Jekyll and Jekyll Sass Converter on GitHub Pages, you can now deploy to a GitHub Pages site using GitHub Actions.
sass-embedded gem becomes the default Sass implmentation, and
is no longer supported. As part of this change, support for Ruby 2.5 is dropped.
The Converter will no longer emit
@charset "UTF-8"; or a U+FEFF (byte-order marker) for
scssify Jekyll filters so that this option is no longer needed.
sass-embedded does not support
Dropped support of importing files with non-standard extension names
sass-embedded only allows importing files that have extension names of
.css. Scss syntax in files with
.css extension name will result in a syntax error.
Dropped support of importing files relative to site source
v2.x, the Converter allowed imports using paths relative to site source directory,
even if the site source directory is not in Sass
load_paths. This is a side effect of a
bug in the Converter, which will remain as is in
v2.x due to its usage in the wild.
v3.x, imports using paths relative to site source directory will not work out of box.
To allow these imports,
. (meaning current directory, or site source directory) need to
be explicitly added to
Dropped support of importing files with the same filename as their parent file
v2.x, the Converter allowed imports of files with the same filename as their parent
load_paths. This is a side effect of a bug in the Converter,
which will remain as is in
v2.x due to its usage in the wild.
v3.x, imports using the same filename of parent file will create a circular import.
To fix these imports, rename either of the files, or use complete relative path from the
Behavioral Differences in Sass Implementation
- Fork it ( https://github.com/jekyll/jekyll-sass-converter/fork )
- Create your feature branch (
git checkout -b my-new-feature)
- Commit your changes (
git commit -am 'Add some feature')
- Push to the branch (
git push origin my-new-feature)
- Create new Pull Request