Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/leocaseiro/jquery-plugin-stringtoslug
The stringToSlug converts any string to SLUG (known as spinal-case or kebab-case). Or other (snake_case, PascalCase, ...) in any Languages. Having or not special characters (ã,é,í,ü,ñ...)
https://github.com/leocaseiro/jquery-plugin-stringtoslug
Last synced: 4 days ago
JSON representation
The stringToSlug converts any string to SLUG (known as spinal-case or kebab-case). Or other (snake_case, PascalCase, ...) in any Languages. Having or not special characters (ã,é,í,ü,ñ...)
- Host: GitHub
- URL: https://github.com/leocaseiro/jquery-plugin-stringtoslug
- Owner: leocaseiro
- License: mit
- Created: 2011-07-26T16:59:56.000Z (over 13 years ago)
- Default Branch: master
- Last Pushed: 2022-12-01T22:53:47.000Z (about 2 years ago)
- Last Synced: 2024-12-10T14:39:13.861Z (about 1 month ago)
- Language: HTML
- Homepage: http://leocaseiro.github.io/jQuery-Plugin-stringToSlug/
- Size: 1.17 MB
- Stars: 47
- Watchers: 6
- Forks: 12
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
jQuery plugin stringToSlug [](https://badge.fury.io/bo/jquery.stringtoslug) [](https://travis-ci.org/leocaseiro/jQuery-Plugin-stringToSlug)
=============
A simple plugin in jQuery to create a URL.
The stringToSlug converts string in any language, including those with accents and special characters, to a SLUG.
Documentation
--------------
Full documentation with examples at [http://leocaseiro.github.io/jQuery-Plugin-stringToSlug/](http://leocaseiro.github.io/jQuery-Plugin-stringToSlug/)
Default Usage:
--------------
```javascript
$(document).ready( function() {
$("#string").stringToSlug();
});
```
Install via Bower:
-----------------
```
bower install --save jquery.stringtoslug
```
[Download](https://github.com/leocaseiro/jQuery-Plugin-stringToSlug/archive/v2.1.0.zip):
-----------------
[Click here to download the latest version](https://github.com/leocaseiro/jQuery-Plugin-stringToSlug/archive/v2.1.0.zip)
Description
--------------
The stringToSlug uses a third-party library called [speakingURL](http://pid.github.io/speakingurl/) that removes special characters and converts the string to lowercase. The **StringToSlug** replaces spaces with space characters(separators) and offers the option to add a prefix and/or a suffix for your slug.
In order to transform a string into a url-friendly permalink, use the plugin to display a preview in a *html element* or in an *input form*.
Contributing
------------
The **StringToSlug** uses [**NodeJS with NPM**](http://nodejs.org/) and [**Gulp**](http://gulpjs.com/) to compile a code, and [**QUnit**](https://qunitjs.com/) and [**Karma**](http://karma-runner.github.io/) for testing:
To install **Bower** and **Gulp** globally, use **npm install -g**:
```shell
npm install bower -g
npm install gulp -g
```
Download and install all dependencies with **NPM** and make sure **Bower** is up to date:
```shell
npm install
bower install
```
List all tasks with **Gulp**
```shell
gulp
```
Watch all files with **gulp watcher** to develop and test in realtime
```shell
gulp watcher
```
Use **gulp tests** for testing
```shell
gulp tests
```
Use **gulp build** to compile
```shell
gulp build
```
License
------------
Copyright (c) 2009-2018 Leo Caseiro. This is free software and is licensed under the MIT License.
Created and maintained by [Leo Caseiro](http://about.me/leocaseiro)