https://github.com/kentaroutakeda/hexo-renderer-dartsass

Sass renderer plugin for Hexo (use dartsass instead of libsass)
https://github.com/kentaroutakeda/hexo-renderer-dartsass

dart-sass hexo hexo-renderer sass

Last synced: 11 days ago
JSON representation

Sass renderer plugin for Hexo (use dartsass instead of libsass)

• Host: GitHub
• URL: https://github.com/kentaroutakeda/hexo-renderer-dartsass
• Owner: KentarouTakeda
• Created: 2021-06-11T23:37:09.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2024-10-15T02:04:38.000Z (2 months ago)
• Last Synced: 2024-12-07T04:27:34.354Z (18 days ago)
• Topics: dart-sass, hexo, hexo-renderer, sass
• Language: TypeScript
• Homepage: https://www.npmjs.com/package/hexo-renderer-dartsass
• Size: 26.4 KB
• Stars: 3
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
[Sass] renderer plugin for [Hexo] using [Dart Sass]

==

[![npm version](https://badge.fury.io/js/hexo-renderer-dartsass.svg)](https://badge.fury.io/js/hexo-renderer-dartsass)

## Install

```sh

$ npm install --save hexo-renderer-dartsass

```

## Config

Anything specified under the key `sass` in your `_config.yml` files will be passed directly to the `sass.compileAsync()` call.

Check out the [Sass API docs](https://sass-lang.com/documentation/js-api/interfaces/options/) for all available settings.

## Additional features

1. Export some handy hexo related global functions to the Sass compiler context like [mamboer/hexo-renderer-scss].

   - hexo-config($key)

     Now you can use `hexo-config` function in your 'scss' files to access your hexo app's site configuration.

     ```

     $highlight_theme: hexo-config('highlight_theme')

     ```

   - hexo-theme-config($key)

     Similar to the `hexo-config`, you can use `hexo-theme-config` to access your hexo theme's configuration.

### _config.yml

```yaml

sass:

  outputStyle: expanded # "expanded" or "compressed"

```

### Inheritance

The config object passed to dart sass is constructed by merging properties from

the following locations using a least-specific-first order:

1. Theme specific `_config.yml`

2. Blog root `_config.yml`

3. Since `file` is the path to be rendered, config is ignored. The same applies to data.

## Thanks

This plugin was created with reference to [knksmith57/hexo-renderer-sass]. Thank you for publishing the nice software.

[Hexo]: http://hexo.io

[Sass]: http://sass-lang.com/

[Dart Sass]: https://sass-lang.com/dart-sass

[node-sass]: https://github.com/andrew/node-sass

[Dart Sass API docs]: https://github.com/sass/dart-sass#javascript-api

[knksmith57/hexo-renderer-sass]: https://github.com/knksmith57/hexo-renderer-sass

[mamboer/hexo-renderer-scss]: https://github.com/mamboer/hexo-renderer-scss