add lisp packages
This commit is contained in:
81
lisp/emacs-application-framework/app/mermaid/node_modules/slugify/README.md
generated
vendored
Normal file
81
lisp/emacs-application-framework/app/mermaid/node_modules/slugify/README.md
generated
vendored
Normal file
@@ -0,0 +1,81 @@
|
||||
|
||||
# slugify
|
||||
|
||||
[![npm-version]][npm] [![travis-ci]][travis] [![coveralls-status]][coveralls]
|
||||
|
||||
```js
|
||||
var slugify = require('slugify')
|
||||
|
||||
slugify('some string') // some-string
|
||||
|
||||
// if you prefer something other than '-' as separator
|
||||
slugify('some string', '_') // some_string
|
||||
```
|
||||
|
||||
- Vanilla ES5 JavaScript
|
||||
- No dependencies
|
||||
- Coerces foreign symbols to their English equivalent (check out the [charMap][charmap] for more details)
|
||||
- Works in the browser (window.slugify) and AMD/CommonJS-flavored module loaders
|
||||
|
||||
## Options
|
||||
|
||||
```js
|
||||
slugify('some string', {
|
||||
replacement: '-', // replace spaces with replacement character, defaults to `-`
|
||||
remove: undefined, // remove characters that match regex, defaults to `undefined`
|
||||
lower: false, // convert to lower case, defaults to `false`
|
||||
strict: false, // strip special characters except replacement, defaults to `false`
|
||||
})
|
||||
```
|
||||
|
||||
For example, to remove `*+~.()'"!:@` from the result slug, you can use `slugify('..', {remove: /[*+~.()'"!:@]/g})`.
|
||||
|
||||
## Extend
|
||||
|
||||
Out of the box `slugify` comes with support for a handful of Unicode symbols. For example the `☢` (radioactive) symbol is not defined in the [`charMap`][charmap] and therefore it will be stripped by default:
|
||||
|
||||
```js
|
||||
slugify('unicode ♥ is ☢') // unicode-love-is
|
||||
```
|
||||
|
||||
However you can extend the supported symbols, or override the existing ones with your own:
|
||||
|
||||
```js
|
||||
slugify.extend({'☢': 'radioactive'})
|
||||
slugify('unicode ♥ is ☢') // unicode-love-is-radioactive
|
||||
```
|
||||
|
||||
Keep in mind that the `extend` method extends/overrides the default `charMap` for the entire process. In case you need a fresh instance of the slugify's `charMap` object you have to clean up the module cache first:
|
||||
|
||||
```js
|
||||
delete require.cache[require.resolve('slugify')]
|
||||
var slugify = require('slugify')
|
||||
```
|
||||
|
||||
## Contribute
|
||||
|
||||
1. Add chars to `charmap.json`
|
||||
2. Run tests `npm test`
|
||||
3. The tests will build the charmap in `index.js` and will sort the `charmap.json`
|
||||
4. Commit **all** modified files
|
||||
|
||||
---
|
||||
|
||||
> This module was originally a vanilla javascript port of [node-slug][node-slug].<br>
|
||||
> Note that the original [slug][slug] module has been ported to vanilla javascript too.<br>
|
||||
> One major difference between the two modules is that `slugify` does not depend on the external [unicode][unicode] module.
|
||||
|
||||
|
||||
[npm-version]: https://img.shields.io/npm/v/slugify.svg?style=flat-square (NPM Package Version)
|
||||
[travis-ci]: https://img.shields.io/travis/simov/slugify/master.svg?style=flat-square (Build Status - Travis CI)
|
||||
[coveralls-status]: https://img.shields.io/coveralls/simov/slugify.svg?style=flat-square (Test Coverage - Coveralls)
|
||||
|
||||
[npm]: https://www.npmjs.com/package/slugify
|
||||
[travis]: https://travis-ci.org/simov/slugify
|
||||
[coveralls]: https://coveralls.io/r/simov/slugify?branch=master
|
||||
|
||||
[node-slug]: https://github.com/dodo/node-slug
|
||||
[slug]: https://www.npmjs.com/package/slug
|
||||
[unicode]: https://www.npmjs.com/package/unicode
|
||||
[index]: https://github.com/simov/slugify/blob/master/index.js
|
||||
[charmap]: https://github.com/simov/slugify/blob/master/config/charmap.json
|
||||
Reference in New Issue
Block a user