Jekyll Sass Converter 使用指南

Jekyll Sass Converter 使用指南

jekyll-sass-converter A Sass converter for Jekyll. 项目地址: https://gitcode.com/gh_mirrors/je/jekyll-sass-converter

1. 项目目录结构及介绍

Jekyll Sass Converter 是一个专为 Jekyll 设计的用于编译 Sass 和 SCSS 文件到 CSS 的插件。以下是一个典型的项目结构，虽然它直接来自于 Jekyll 的一般结构，但请注意该插件自身的目录结构相对简单：

your-jekyll-site/
├── _sass/             # 默认的Sass部分文件夹
├── assets/            # 可能存放着你的Sass文件
├── Gemfile            # 定义了项目所需宝石，包括jekyll-sass-converter
├── _config.yml        # 配置文件，可以指定Sass编译选项
├── index.html         # 主页文件
└── ...

• _sass/：这是Jekyll默认查找Sass partials（片段）的目录。
• Gemfile：在这里添加 gem 'jekyll-sass-converter' 来确保项目能够使用此转换器。
• _config.yml：包含了Jekyll和插件的配置信息，包括本插件的相关设置。

2. 项目的启动文件介绍

在Jekyll项目中，并没有特定于“启动文件”的概念，但是有两个关键文件参与到了项目的初始化和构建过程：

• Gemfile：这个文件是用来列出项目依赖的所有Ruby库，为了使用Jekyll Sass Converter，你需要在此文件中添加相应的gem声明。

  gem 'jekyll-sass-converter'
  

  然后通过运行 bundle install 来安装这些依赖。

• _config.yml：虽然这不是启动文件，但它配置了整个Jekyll站点，包括Jekyll Sass Converter的某些行为，例如输出CSS的风格等。

3. 项目的配置文件介绍

主要关注的是 _config.yml 文件中的Jekyll Sass Converter相关配置：

sass:
  style:           expanded     # 缩放样式，默认展开式，可选值：compressed 或 expanded
  sass_dir:        _sass        # Sass源文件目录，默认是_sass
  load_paths:      ["#{site.source}/assets"]  # 额外的Sass查找路径
  sourcemap:       true        # 是否生成source map，默认true，在开发环境尤其有用
  quiet_deps:      false       # 是否抑制依赖项警告，默认false
  verbose:         false       # 是否显示全部的Deprecation Warnings，默认false

• style: 控制CSS的输出形式，压缩或扩展，默认为expanded。
• sass_dir: 指定Sass文件的存储位置，默认为_sass。
• load_paths: 指定额外的目录来搜索Sass文件。
• sourcemap: 控制是否生成source map以辅助调试，可以在生产环境中设为never。
• quiet_deps 和 verbose: 分别控制依赖项警告的输出量。

以上配置允许你微调Sass编译的过程，使之更符合你的开发习惯和部署需求。确保在修改配置之后重新构建Jekyll站点以应用更改。

jekyll-sass-converter A Sass converter for Jekyll. 项目地址: https://gitcode.com/gh_mirrors/je/jekyll-sass-converter