Описание тега node-sass
Node-sass - это библиотека, которая обеспечивает привязку Node.js к libsass, версии C популярного препроцессора таблиц стилей Sass.
Это позволяет вам компилировать файлы.scss в CSS с невероятной скоростью и автоматически через промежуточное ПО для подключения.
Найдите его на npm: https://npmjs.org/package/node-sass
Установить
npm install node-sass
Применение
var sass = require('node-sass');
sass.render({
file: scss_filename,
success: callback
[, options..]
});
// OR
var css = sass.renderSync({
data: scss_content
[, options..]
});
Параметры
API для использования node-sass изменился, так что теперь есть только одна переменная - хеш опций. Некоторые из этих параметров являются необязательными, а в некоторых случаях - обязательными. файл
file
представляет собой строку пути к файлу scss для рендеринга libsass. Один из вариантов this или data требуется как для render, так и для renderSync. данные
data
- это строка, содержащая scss, который будет отображаться libsass. Один из параметров this или file требуется как для render, так и для renderSync. Рекомендуется использовать вместе с этим параметр includePaths, иначе у libsass могут возникнуть проблемы с поиском файлов, импортированных с помощью директивы @import.
успех
success
- это функция, которая вызывается после успешного рендеринга scss в css. Эта опция требуется, но только для функции рендеринга. Если предоставленоrenderSync
он будет проигнорирован.
ошибка
error
- это функция, которая вызывается при возникновении ошибки при рендеринге scss в css. Этот параметр не является обязательным и применяется только к функции рендеринга. Если предоставленоrenderSync
он будет проигнорирован.
includePaths
includePaths
представляет собой массив строк пути для поиска любых импортированных файлов. Рекомендуется использовать эту опцию, если вы используете опцию данных и у вас есть@import
директивы, иначе libsass может не найти ваши зависимые файлы.
imagePath
imagePath
- это строка, представляющая путь к общедоступному изображению. При использованииimage-url()
в таблице стилей этот путь будет добавлен к указанному вами пути. например. УчитываяimagePath
из /path/to/images
, background-image: image-url('image.png')
будет компилироваться в background-image: url("/path/to/images/image.png")
outputStyle
outputStyle
- это строка, определяющая, как должен отображаться окончательный CSS. Его значение должно быть одним из'nested'
, 'expanded'
, 'compact'
, 'compressed'
. [Важно: в настоящее время аргументoutputStyle
имеет некоторую проблему, которая может привести к тому, что выходной css станет ничем из-за libsass, поэтому вам не следует использовать его сейчас!]
источникКомментарии
sourceComments
представляет собой строку, определяющую, какая отладочная информация включается в выходной файл. Его значение должно быть одним из'none'
, 'normal'
, 'map'
. По умолчанию'none'
. Параметр карты создаст файл исходной карты в вашем месте назначения CSS. [Важный:souceComments
поддерживается только при использовании параметра файла и ничего не делает при использовании data
флаг.]
sourceMap
Если твой sourceComments
опция установлена на карту, sourceMap
позволяет установить новый контекст пути для файлов Sass, на которые имеются ссылки. Исходная карта описывает путь от местоположения вашего файла CSS в папку, в которой находятся файлы Sass. В большинстве случаев это сработает "из коробки", но в некоторых случаях вам может потребоваться установить другой вывод.
Дополнительная информация: https://github.com/andrew/node-sass