https://github.com/bradgarropy/plop-helper-slugify

A plop helper that slugifies text.
https://github.com/bradgarropy/plop-helper-slugify

helper plop plop-helper plop-pack slug slugify

Last synced: about 1 month ago
JSON representation

A plop helper that slugifies text.

• Host: GitHub
• URL: https://github.com/bradgarropy/plop-helper-slugify
• Owner: bradgarropy
• License: mit
• Created: 2020-07-28T02:47:13.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2022-03-27T06:53:59.000Z (almost 3 years ago)
• Last Synced: 2024-11-12T22:09:34.842Z (about 1 month ago)
• Topics: helper, plop, plop-helper, plop-pack, slug, slugify
• Language: JavaScript
• Homepage: https://npmjs.com/package/plop-helper-slugify
• Size: 119 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 4
• Metadata Files:
  • Readme: readme.md
  • License: license

Awesome Lists containing this project

README

        
## 💧 plop-helper-slugify



    





    



_A [plop][plop] helper that slugifies text._

### 📦 Installation

This package is installable from [npm][npm].

```bash

npm install --save-dev plop-helper-slugify

```

### 🥑 Usage

Before you can use the `plop-pack`, you have to load it into the `plop` object.

```javascript

plop.load("plop-helper-slugify")

```

Once loaded, you now have access the following helpers.

#### `slugify`

Creates a slug for any input text.

**input**

```javascript

{

    title: "This Is An Example Slug"

}

```

**helper**

```handlebars

{{slug title}}

```

**output**

```javascript

"this-is-an-example-slug"

```

### ❔ Questions

🐛 report bugs by filing [issues][issues]  

📢 provide feedback with [issues][issues] or on [twitter][twitter]  

🙋🏼‍♂️ use my [ama][ama] or [twitter][twitter] to ask any other questions

[plop]: https://plopjs.com

[npm]: https://npmjs.com

[bradgarropy]: https://bradgarropy.com

[issues]: https://github.com/bradgarropy/plop-helper-slugify/issues

[twitter]: https://twitter.com/bradgarropy

[ama]: https://github.com/bradgarropy/ama