# handlebars-helper-slugify

> {{slugify}} handlebars helper. Uses the awesome underscore.string to transform text into a URL slug. Replaces whitespaces, accentuated and special characters with a dash.

Latest version **0.3.2** (published 2014-05-10) · 0 weekly downloads

## Install

```sh
npm install handlebars-helper-slugify
pnpm add handlebars-helper-slugify
yarn add handlebars-helper-slugify
bun add handlebars-helper-slugify
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.3.2 |
| Published | 2014-05-10 |
| First published | 2013-12-08 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 3 |
| Author | Jon Schlinkert |
| Maintainers | jonschlinkert |
| Keywords | assemble, assemblehelper, dasherize, dashify, handlebars, helper, slug, slugify, slugifier, url |

## Links

- npm: https://www.npmjs.com/package/handlebars-helper-slugify
- Repository: https://github.com/helpers/handlebars-helper-slugify
- Issues: https://github.com/helpers/handlebars-helper-slugify/issues
- npm.io page: https://npm.io/package/handlebars-helper-slugify

## Alternatives

- [base64url](https://npm.io/package/base64url.md) — 6.1M weekly downloads
- [get-installed-path](https://npm.io/package/get-installed-path.md) — 502.9K weekly downloads
- [@uppy/url](https://npm.io/package/@uppy/url.md) — 185.8K weekly downloads
- [@d3fc/d3fc-shape](https://npm.io/package/@d3fc/d3fc-shape.md) — 16.2K weekly downloads
- [localizer](https://npm.io/package/localizer.md) — 226 weekly downloads

## Recent versions

- 0.3.2 (latest) — 2014-05-10
- 0.3.1 — 2014-05-10
- 0.3.0 — 2014-05-10
- 0.2.0 — 2013-12-08

## README

# {{handlebars-helper-slugify}} [![NPM version](https://badge.fury.io/js/handlebars-helper-slugify.png)](http://badge.fury.io/js/handlebars-helper-slugify)

> {{slugify}} handlebars helper. Uses the awesome underscore.string to transform text into a URL slug. Replaces whitespaces, accentuated and special characters with a dash.

**Heads up!** v0.3.0 of this helper requires Assemble v0.5.0 and greater!


## Install

Use [npm](npmjs.org) to install the package: `npm i handlebars-helper-slugify`.

To automatically load helpers from node_modules, see [resolve-dep](https://github.com/jonschlinkert/resolve-dep).

## Register the helper

In your project's Gruntfile, to register the helper add `handlebars-helper-slugify` to the `helpers` property in the [Assemble](http://assemble.io) task or target options:

```javascript
grunt.initConfig({
  assemble: {
    options: {
      // the 'handlebars-helper-slugify' npm module must also be listed in
      // devDependencies for assemble to automatically resolve the helper
      helpers: ['handlebars-helper-slugify', 'foo/*.js']
    },
    files: {
      '_gh_pages/': ['templates/pages/*.hbs']
    }
  }
});
```

Now that the helper is registered, you may begin using it in your templates.

## Usage

Given file name: `Executive Summary 2013.md`:

```html
{{slugify page.filename}}
```

Renders to `executive-summary-2013.md`.

## Credit
This helper is based on the `slugify` method from [underscore.string](http://epeli.github.com/underscore.string/), thank you to the maintainers and contributors of that library!

## Author

**Jon Schlinkert**

+ [github/jonschlinkert](https://github.com/jonschlinkert)
+ [twitter/jonschlinkert](http://twitter.com/jonschlinkert)

## License
Copyright (c) 2014 Jon Schlinkert, contributors.  
Released under the MIT license

***

_This file was generated by [verb-cli](https://github.com/assemble/verb-cli) on May 10, 2014._

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