# slugifyjs

> Javascript slugify routine, handling diacritics / accents.

Latest version **0.0.7** (published 2016-12-10) · MIT license · 0 weekly downloads

## Install

```sh
npm install slugifyjs
pnpm add slugifyjs
yarn add slugifyjs
bun add slugifyjs
```

## 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.7 |
| Published | 2016-12-10 |
| First published | 2015-03-19 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 8 |
| Author | Anthony Matarazzo |
| Maintainers | createvibe |
| Keywords | slugify, slugifyjs, slugify-js, slug |

## Links

- npm: https://www.npmjs.com/package/slugifyjs
- Repository: https://github.com/createvibe/slugify.js
- Homepage: https://github.com/createvibe/slugify.js#readme
- Issues: https://github.com/createvibe/slugify.js/issues
- npm.io page: https://npm.io/package/slugifyjs

## Alternatives

- [@mce/gif](https://npm.io/package/@mce/gif.md) — 2.6K weekly downloads
- [cleanse](https://npm.io/package/cleanse.md) — 173 weekly downloads
- [str](https://npm.io/package/str.md) — 127 weekly downloads
- [naming](https://npm.io/package/naming.md) — 95 weekly downloads
- [tap-telco-api](https://npm.io/package/tap-telco-api.md) — 19 weekly downloads

## Recent versions

- 0.0.7 (latest) — 2016-12-10
- 0.0.6 — 2016-01-24
- 0.0.5 — 2016-01-23
- 0.0.4 — 2016-01-23
- 0.0.3 — 2016-01-23
- 0.0.2 — 2015-03-19
- 0.0.1 — 2015-03-19

## README

# slugify.js
Javascript slugify routine, handling diacritics / accents.  

Includes an English - Diacritic map.  

Extensible, so you can build your own diacritic map (locale).

# Examples

### Using the English locale
```javascript
Slugify.parse('Iñtërnâtiônàlizætiøn');    // internationalizaetion
  
Slugify.parse('C’est Déjà L’été');        // cest-deja-lete
  
Slugify.parse('Україна');                 // y
  
Slugify.parse('東西放在這裡');              // 東

Slugify.parse('kääntää jotain minulle');  // kaantaa-jotain-minulle
```

### Using NodeJS
```javascript
var Slugify = require('slugifyjs').fromLocale('en');

Slugify.parse('slugify this for me please');		// slugify-this-for-me-please
```

# NPM
Install with npm: `npm install slugifyjs`

# Bower
Install with bower: `bower install slugifyjs`

# Contributing
Use `grunt dev` to test your changes with a version that is not uglified.

Use `grunt` to compress an uglified file after you make changes.

*Please do not submit a PR with a compiled file for dev.*

# Tests
Run `npm test` to execute mocha tests.

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