# slugify3

> Unidecode based slugify implementation and CLI tool for file renaming

Latest version **0.0.4** (published 2015-02-07) · MIT license · 0 weekly downloads

## Install

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

Provides the command `slugify`.

## 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.4 |
| Published | 2015-02-07 |
| First published | 2014-07-29 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | monai |
| Maintainers | monai |
| Keywords | slug, slugify, cli |

## Links

- npm: https://www.npmjs.com/package/slugify3
- Repository: git@github.com:monai/node-slugify3
- Homepage: https://github.com/monai/slugify
- Issues: https://github.com/monai/slugify/issues
- npm.io page: https://npm.io/package/slugify3

## Dependencies (3)

- [async](https://npm.io/package/async.md) ~0.7.0
- [yargs](https://npm.io/package/yargs.md) ~1.2.6
- [unidecode](https://npm.io/package/unidecode.md) ~0.1.3

## Alternatives

- [@salesforce/cli](https://npm.io/package/@salesforce/cli.md) — 389.7K weekly downloads
- [@mintlify/cli](https://npm.io/package/@mintlify/cli.md) — 208.9K weekly downloads
- [@grafana/e2e-selectors](https://npm.io/package/@grafana/e2e-selectors.md) — 128.7K weekly downloads
- [mintlify](https://npm.io/package/mintlify.md) — 112.0K weekly downloads
- [@intlayer/cli](https://npm.io/package/@intlayer/cli.md) — 22.8K weekly downloads

## Recent versions

- 0.0.4 (latest) — 2015-02-07
- 0.0.3 — 2014-07-29

## README

# slugify3

[![Build Status](http://img.shields.io/travis/monai/node-slugify3/develop.svg)](https://travis-ci.org/monai/node-slugify3)
[![NPM Version](http://img.shields.io/npm/v/slugify3.svg)](https://www.npmjs.org/package/slugify3)

Unidecode based slugify implementation and CLI tool for file renaming.

This slugify implementation is unique in the way that uses [unidecode](https://www.npmjs.org/package/unidecode) transliteration table. It tries to transliterate non-ascii symbols first before omitting them.

## Installation

Install as dependency:

`npm install slugify3`

Install as CLI tool:

`npm install -g slugify3`

## How to use

``` js
var slugify = require('slugify3');
slugify('Language Learning and Teaching');
slugify('Изучение и обучение иностранных языков', '+');
slugify('語文教學・语文教学');
```

## API

**slugify(string, separator)**

- `string` String - an unicode string to slugify
- `separator` String, - optional, default "-", a replacement character for non-ascii symbols and spaces

## CLI

```
Usage: slugify [OPTIONS] FILE

Options:
  -e  lowercase file extension
```

## License

MIT

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