File: README.md

package info (click to toggle)
jquery-slugify.js 1.2.4~dfsg1-1
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 116 kB
  • ctags: 11
  • sloc: makefile: 7
file content (38 lines) | stat: -rw-r--r-- 1,132 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
[![Build Status](https://travis-ci.org/madflow/jquery-slugify.png?branch=master)](https://travis-ci.org/madflow/jquery-slugify)

# jQuery Slugify

Just another another (another) url slug creation plugin for jQuery.

## Getting Started

You can install the plugin using Bower:

    bower install jquery-slugify

You can download the [production version][min] or the [development version][max].

[min]: https://raw.github.com/madflow/jquery-slugify/master/dist/slugify.min.js
[max]: https://raw.github.com/madflow/jquery-slugify/master/dist/slugify.js

The plugin depends on [speakingurl][speakingurl].

[speakingurl]: https://github.com/pid/speakingurl

In your web page:

```html
<script src="jquery.js"></script>
<script src="speakingurl.min.js"></script>
<script src="slugify.min.js"></script>

<input type ="text" value="" id="slug-source" /> <!-- The text to be slugged -->
<input type ="text" value="" id="slug-target" /> <!-- The processed text as slug -->

<script>
jQuery(function($) {
  $.slugify("Ätschi Bätschi"); // "aetschi-baetschi"
  $('#slug-target').slugify('#slug-source'); // Type as you slug
});
</script>
```