{"repo":"lovell/limax","free":true,"listed":false,"github":"https://github.com/lovell/limax","clone":"git clone https://github.com/lovell/limax.git","description":"Node.js module to generate URL slugs. Another one? This one cares about i18n and transliterates non-Latin scripts to conform to the RFC3986 standard. Mostly API-compatible with similar modules.","language":"JavaScript","stars":605,"topics":["javascript","pinyin","i18n","nodejs","transliteration","url","seo","slug","speakingurl","hepburn"],"license":"Apache-2.0","category":"dev-tools","readme_excerpt":"limax (Yet another) Node.js module to generate URL slugs, also known as clean URLs, user-friendly URLs and SEO-friendly URLs. The difference? This module extends the fantastic speakingurl module to include Romanisation of Chinese and Japanese scripts. Give it a string of text in pretty much any major world language and it will convert it to valid characters, conforming to RFC3986, for use within the path element of a URL. Currently supports, but not limited to, the following scripts: Latin: e.g. English, français, Deutsch, español, português Cyrillic: e.g. русский язык, български език, українська мова Chinese: e.g. 官话, 吴语 (converts to Latin script using Pinyin with optional tone number) Japanese: e.g. ひらがな, カタカナ (converts to Romaji using Hepburn) If you already use either the speakingurl or slug modules, you can probably swap in limax without changing the logic in your code. Oh, and limax is the Latin word for slug. Install npm install limax Usage slug(text) slug(text, options) options: replacement : String to replace whitespace with, defaults to - (provides API compatibility with the slug module) separator : String, equivalent to replacement (provides API compatibility with the speakingurl module) lang : String, ISO 639-1 two-letter language code, defaults to auto-detected language tone : Boolean, add tone numbers to Pinyin transliteration of Chinese, defaults to true separateNumbers : Boolean, separate numbers that are within a word, defaults to false separateApostrophes : ","default_branch":null,"files":null,"tree":[],"storefront":"/r/lovell","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/lovell/limax/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}