From 9ed85a028a205737176399d1bbf258739ca4e6f2 Mon Sep 17 00:00:00 2001 From: Sesh Sadasivam Date: Fri, 14 May 2021 16:39:12 -0400 Subject: [PATCH] Add documentation for Sass configuration options (#8587) Merge pull request 8587 --- docs/_docs/assets.md | 2 ++ docs/_docs/configuration.md | 1 + docs/_docs/configuration/default.md | 2 +- docs/_docs/configuration/sass.md | 15 +++++++++++++++ 4 files changed, 19 insertions(+), 1 deletion(-) create mode 100644 docs/_docs/configuration/sass.md diff --git a/docs/_docs/assets.md b/docs/_docs/assets.md index 20904148..2cba9c95 100644 --- a/docs/_docs/assets.md +++ b/docs/_docs/assets.md @@ -79,6 +79,8 @@ sass: These are passed to Sass, so any output style options Sass supports are valid here, too. +For more information on Sass configuration options, see the [Sass configuration]({{ '/docs/configuration/sass/' | relative_url }}) docs. + ## Coffeescript To enable Coffeescript in Jekyll 3.0 and up you must diff --git a/docs/_docs/configuration.md b/docs/_docs/configuration.md index b542bd97..6cf66850 100644 --- a/docs/_docs/configuration.md +++ b/docs/_docs/configuration.md @@ -14,5 +14,6 @@ executable in the terminal. * [Environments]({{ '/docs/configuration/environments/' | relative_url }}) * [Markdown Options]({{ '/docs/configuration/markdown/' | relative_url }}) * [Liquid Options]({{ '/docs/configuration/liquid/' | relative_url }}) +* [Sass/SCSS Options]({{ '/docs/configuration/sass/' | relative_url }}) * [Webrick Options]({{ '/docs/configuration/webrick/' | relative_url }}) * [Incremental Regeneration]({{ '/docs/configuration/incremental-regeneration/' | relative_url }}) diff --git a/docs/_docs/configuration/default.md b/docs/_docs/configuration/default.md index 5d839f0d..e96c5071 100644 --- a/docs/_docs/configuration/default.md +++ b/docs/_docs/configuration/default.md @@ -10,7 +10,7 @@ file or on the command-line.
Be aware of directory paths

- Make directory path values in configuration keys like `plugins_dir` relative to the current working directory, not the site source. + In general, make directory path values in configuration keys like plugins_dir relative to the current working directory, not the site source. The sass configuration key is an exception, where values must be relative to the site source.

diff --git a/docs/_docs/configuration/sass.md b/docs/_docs/configuration/sass.md new file mode 100644 index 00000000..14c142f7 --- /dev/null +++ b/docs/_docs/configuration/sass.md @@ -0,0 +1,15 @@ +--- +title: Sass/SCSS Options +permalink: "/docs/configuration/sass/" +--- + +Jekyll comes bundled with [jekyll-sass-converter](https://github.com/jekyll/jekyll-sass-converter) plugin. By default, Jekyll will look for Sass partials in the `_sass` directory relative to your site's `source` directory. + +You can further configure the plugin by adding options to your Jekyll config under the `sass` attribute. See the [plugin's documentation](https://github.com/jekyll/jekyll-sass-converter#usage) for details and for its default values. + +
+

+ Note that directory paths specified in the sass configuration + are resolved relative to your site's source, not relative to the location of the _config.yml file. +

+