https://github.com/monai/node-slugify3

Unicode based slugify implementation and CLI tool for file renaming
https://github.com/monai/node-slugify3

Last synced: 4 days ago
JSON representation

Unicode based slugify implementation and CLI tool for file renaming

• Host: GitHub
• URL: https://github.com/monai/node-slugify3
• Owner: monai
• Created: 2014-01-14T12:08:44.000Z (almost 11 years ago)
• Default Branch: develop
• Last Pushed: 2015-06-11T13:20:16.000Z (over 9 years ago)
• Last Synced: 2024-10-05T03:27:23.050Z (about 1 month ago)
• Language: JavaScript
• Homepage:
• Size: 238 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

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