# grunt-livingstyleguide

> Easily create living style guides/front-end style guides/pattern libraries by adding Markdown documentation to your Sass project.

Latest version **1.0.3** (published 2015-01-05) · 0 weekly downloads

## Install

```sh
npm install grunt-livingstyleguide
pnpm add grunt-livingstyleguide
yarn add grunt-livingstyleguide
bun add grunt-livingstyleguide
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.3 |
| Published | 2015-01-05 |
| First published | 2015-01-03 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 0.8.0 |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 5 |
| Author | Damian Duda |
| Maintainers | balmor |
| Keywords | gruntplugin, grunt, livingstyleguide, styleguide, markdown, scss, sass, css |

## Links

- npm: https://www.npmjs.com/package/grunt-livingstyleguide
- Repository: https://github.com/NexwayGroup/grunt-livingstyleguide
- Issues: https://github.com/NexwayGroup/grunt-livingstyleguide/issues
- npm.io page: https://npm.io/package/grunt-livingstyleguide

## Dependencies (1)

- [which](https://npm.io/package/which.md) ^1.0.8

## Alternatives

- [style-dictionary](https://npm.io/package/style-dictionary.md) — 2.0M weekly downloads
- [postcss-merge-idents](https://npm.io/package/postcss-merge-idents.md) — 1.7M weekly downloads
- [@fontsource/noto-sans](https://npm.io/package/@fontsource/noto-sans.md) — 93.0K weekly downloads
- [uglifycss](https://npm.io/package/uglifycss.md) — 71.6K weekly downloads
- [mat4-interpolate](https://npm.io/package/mat4-interpolate.md) — 23.3K weekly downloads

## Recent versions

- 1.0.3 (latest) — 2015-01-05
- 1.0.2 — 2015-01-03
- 1.0.1 — 2015-01-03
- 1.0.0 — 2015-01-03

## README

# grunt-livingstyleguide   [![Build Status](https://travis-ci.org/NexwayGroup/grunt-livingstyleguide.svg?branch=master)](https://travis-ci.org/NexwayGroup/grunt-livingstyleguide)

> Generate livingstyleguide with Grunt.    
Easily create living style guides/front-end style guides/pattern libraries by adding Markdown documentation to your Sass project.

## Style Guide Setup

First you have to install the livingstyleguide gem:

```shell
gem install livingstyleguide
```

[Livingstyleguide workshop](https://github.com/hagenburger/livingstyleguide-workshop)

## Getting Started
This plugin requires Grunt.

If you haven't used [Grunt](http://gruntjs.com/) before, be sure to check out the [Getting Started](http://gruntjs.com/getting-started) guide, as it explains how to create a [Gruntfile](http://gruntjs.com/sample-gruntfile) as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:

```shell
npm install grunt-livingstyleguide --save-dev
```

Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:

```js
grunt.loadNpmTasks('grunt-livingstyleguide');
```

## The "livingstyleguide" task

### Overview
In your project's Gruntfile, add a section named `livingstyleguide` to the data object passed into `grunt.initConfig()`.

```js
grunt.initConfig({
  livingstyleguide: {
    generate: {
      options: {
        src: 'test/fixtures/styleguide.lsg'
      }
    }
  },
})
```

### Options

#### options.src
Type: `String`   
**Required*

The path to your livingstyleguide config file.

#### options.dest
Type: `String`   
Default value: `styleguide.html`   
**Optional*

The path to your destination file.

### Usage Examples

#### Default Options

```js
grunt.initConfig({
  livingstyleguide: {
    generate: {
      options: {
        src: 'test/fixtures/styleguide.lsg',
        dest: 'tmp/styleguide.html'
      }
    }
  },
})
```

## Contributing
In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using [Grunt](http://gruntjs.com/).

## License
Copyright (c) 2015 Nexway Lab. Licensed under the MIT license.

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