dan
/
jekyll
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add documentation for Sass configuration options (#8587) 

Merge pull request 8587
This commit is contained in:
Sesh Sadasivam 2021-05-14 16:39:12 -04:00 committed by GitHub
parent 2a4d9dfedf
commit 9ed85a028a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 19 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/_docs/assets.md
View File

@ -79,6 +79,8 @@ sass:
These are passed to Sass, so any output style options Sass supports are valid These are passed to Sass, so any output style options Sass supports are valid
here, too. here, too.
For more information on Sass configuration options, see the [Sass configuration]({{ '/docs/configuration/sass/' | relative_url }}) docs.
## Coffeescript ## Coffeescript
To enable Coffeescript in Jekyll 3.0 and up you must To enable Coffeescript in Jekyll 3.0 and up you must

1
docs/_docs/configuration.md
View File

@ -14,5 +14,6 @@ executable in the terminal.
* [Environments]({{ '/docs/configuration/environments/' | relative_url }}) * [Environments]({{ '/docs/configuration/environments/' | relative_url }})
* [Markdown Options]({{ '/docs/configuration/markdown/' | relative_url }}) * [Markdown Options]({{ '/docs/configuration/markdown/' | relative_url }})
* [Liquid Options]({{ '/docs/configuration/liquid/' | relative_url }}) * [Liquid Options]({{ '/docs/configuration/liquid/' | relative_url }})
* [Sass/SCSS Options]({{ '/docs/configuration/sass/' | relative_url }})
* [Webrick Options]({{ '/docs/configuration/webrick/' | relative_url }}) * [Webrick Options]({{ '/docs/configuration/webrick/' | relative_url }})
* [Incremental Regeneration]({{ '/docs/configuration/incremental-regeneration/' | relative_url }}) * [Incremental Regeneration]({{ '/docs/configuration/incremental-regeneration/' | relative_url }})

2
docs/_docs/configuration/default.md
View File

@ -10,7 +10,7 @@ file or on the command-line.
<div class="note info"> <div class="note info">
<h5>Be aware of directory paths</h5> <h5>Be aware of directory paths</h5>
<p> <p>
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 <code>plugins_dir</code> relative to the current working directory, not the site source. The <code>sass</code> configuration key is an exception, where values must be relative to the site source.
</p> </p>
</div> </div>

15
docs/_docs/configuration/sass.md Normal file
View File

@ -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.
<div class="note info">
<p>
Note that directory paths specified in the <code>sass</code> configuration
are resolved relative to your site's <code>source</code>, not relative to the location of the <code>_config.yml</code> file.
</p>
</div>