# sass-generate-contents

> creates a file with all sass imports neccessary to build single website css file. It also creates a contents type directory based on the first comments line of each imported sass file

Latest version **0.0.1** (published 2015-05-30) · ISC license · 0 weekly downloads

## Install

```sh
npm install sass-generate-contents
pnpm add sass-generate-contents
yarn add sass-generate-contents
bun add sass-generate-contents
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.1 |
| Published | 2015-05-30 |
| First published | 2015-05-30 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Andrew Brandwood |
| Maintainers | andrewbrandwood |
| Keywords | gulp, plugin |

## Links

- npm: https://www.npmjs.com/package/sass-generate-contents
- Repository: https://github.com/andrewbrandwood/sass-generate-contents
- Homepage: https://github.com/andrewbrandwood/sass-generate-contents#readme
- Issues: https://github.com/andrewbrandwood/sass-generate-contents.git/issues
- npm.io page: https://npm.io/package/sass-generate-contents

## Dependencies (2)

- [gulp](https://npm.io/package/gulp.md) ^3.8.11
- [gulp-load-plugins](https://npm.io/package/gulp-load-plugins.md) ^0.10.0

## Recent versions

- 0.0.1 (latest) — 2015-05-30

## README

# sass-generate-contents <a href="https://travis-ci.org/andrewbrandwood/sass-generate-contents"><img align="right" src="https://travis-ci.org/andrewbrandwood/sass-generate-contents.svg?branch=master" alt="Build status" /></a>
Gulp plugin to generate an imports file with a  table of contents 

This plugin was written to help with large scale website builds that use a CSS preprocessor and Gulp as a task runner.

It's purpose is to create a master SASS file to hold the css @imports of all the specified SASS files.  It also generates a list of contents of all SASS files with a description (<sup>*</sup>manual).

The contents are generated from the first line of each individual SASS file.

<sup>*</sup> The plugin requires a comment at the top of each SASS file formatted starting with // (double slash).

The plugin will ignore any files that do not have this on the first line of the file to be imported.


### Example of SASS file to be imported

```SASS
// Navigation Primary ..... CSS styles for the primary navigation

.navigation-primary {
	background: red;
}

```

### Example of Gulp task

```javascript

// Settings 
var sgc = require('sass-generate-contents');
var creds = {
	"Author": 	"Andrew Brandwood",
	"Website": 	"www.Brandwood.com"
}
// *creds are optional*

// Gulp task

gulp.task('sass-generate-contents', function () {
	gulp.src(['sass/**/*.scss','partials/**/*.scss'])
	.pipe(sgc('css/main.scss', creds))
	.pipe(gulp.dest('css'));
});

```

---
_Source: https://npm.io/package/sass-generate-contents · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._