{"id":25106626,"url":"https://github.com/yf-hk/transliteration","last_synced_at":"2026-03-10T12:33:07.422Z","repository":{"id":20111574,"uuid":"23381317","full_name":"yf-hk/transliteration","owner":"yf-hk","description":"UTF-8 to ASCII transliteration / slugify module for node.js, browser, Web Worker, React Native, Electron and CLI.","archived":false,"fork":false,"pushed_at":"2026-01-20T13:29:03.000Z","size":2239,"stargazers_count":622,"open_issues_count":17,"forks_count":56,"subscribers_count":11,"default_branch":"main","last_synced_at":"2026-02-19T23:53:15.219Z","etag":null,"topics":["ascii","character","slugify","transliteration","unicode","utf-8"],"latest_commit_sha":null,"homepage":"http://yf-hk.github.io/transliteration","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/yf-hk.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2014-08-27T07:45:46.000Z","updated_at":"2026-02-18T06:20:17.000Z","dependencies_parsed_at":"2022-08-07T09:15:51.868Z","dependency_job_id":null,"html_url":"https://github.com/yf-hk/transliteration","commit_stats":null,"previous_names":["andyhu/node-transliteration","andyhu/transliteration","yf-hk/transliteration"],"tags_count":9,"template":false,"template_full_name":null,"purl":"pkg:github/yf-hk/transliteration","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yf-hk%2Ftransliteration","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yf-hk%2Ftransliteration/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yf-hk%2Ftransliteration/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yf-hk%2Ftransliteration/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/yf-hk","download_url":"https://codeload.github.com/yf-hk/transliteration/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yf-hk%2Ftransliteration/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30333503,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-10T05:25:20.737Z","status":"ssl_error","status_checked_at":"2026-03-10T05:25:17.430Z","response_time":106,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ascii","character","slugify","transliteration","unicode","utf-8"],"created_at":"2025-02-07T23:01:32.130Z","updated_at":"2026-03-10T12:33:07.413Z","avatar_url":"https://github.com/yf-hk.png","language":"TypeScript","funding_links":[],"categories":["JavaScript","TypeScript"],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\u003cimg src=\"https://yf-hk.github.io/transliteration/transliteration.png\" alt=\"Transliteration\"\u003e\u003c/p\u003e\n\n[![Build and Test](https://img.shields.io/github/actions/workflow/status/yf-hk/transliteration/build.yml?branch=main)](https://github.com/yf-hk/transliteration/actions/workflows/build.yml)\n[![Coverage](https://codecov.io/gh/yf-hk/transliteration/graph/badge.svg)](https://codecov.io/gh/yf-hk/transliteration)\n[![NPM Version](https://img.shields.io/npm/v/transliteration.svg)](https://www.npmjs.com/package/transliteration)\n[![NPM Downloads](https://img.shields.io/npm/dm/transliteration.svg)](https://www.npmjs.com/package/transliteration)\n[![jsDelivr](https://data.jsdelivr.com/v1/package/npm/transliteration/badge)](https://www.jsdelivr.com/package/npm/transliteration)\n[![License](https://img.shields.io/npm/l/transliteration.svg)](https://github.com/yf-hk/transliteration/blob/main/LICENSE.txt)\n\n# Transliteration\n\nA universal Unicode to Latin transliteration and slug generation library. Designed for cross-platform compatibility with comprehensive language support.\n\n**[Live Demo →](https://yf-hk.github.io/transliteration)**\n\n## Table of Contents\n\n- [Features](#features)\n- [Latin-Only Mode](#latin-only-mode)\n- [Compatibility](#compatibility)\n- [Installation](#installation)\n- [Usage](#usage)\n  - [transliterate()](#transliteratestr-options)\n  - [slugify()](#slugifystr-options)\n  - [CLI](#cli-usage)\n- [Known Issues](#known-issues)\n- [License](#license)\n\n## Features\n\n- **Unicode Transliteration** — Convert characters from any writing system to Latin equivalents\n- **Slug Generation** — Create URL-safe and filename-safe strings from Unicode text\n- **Highly Configurable** — Extensive options for custom replacements, ignored characters, and output formatting\n- **Cross-Platform** — Runs seamlessly in Node.js, browsers, and command-line environments\n- **TypeScript Ready** — Full type definitions included out of the box\n- **Zero Dependencies** — Lightweight with no external runtime dependencies\n\n## Latin-Only Mode\n\nFor applications that only need to transliterate Latin-based scripts (Western European languages), you can use the lightweight Latin-only build for significantly smaller bundle size:\n\n```javascript\n// Full build: ~186 KB (all scripts including CJK, Korean, etc.)\nimport { transliterate, slugify } from 'transliteration';\n\n// Latin-only build: ~5 KB (Basic Latin + Latin Extended only)\nimport { transliterate, slugify } from 'transliteration/latin';\n```\n\nThe Latin-only build supports:\n\n- Basic ASCII (U+0000-U+007F)\n- Latin-1 Supplement (U+0080-U+00FF)\n- Latin Extended-A (U+0100-U+017F)\n- Latin Extended-B (U+0180-U+024F)\n\nThis is ideal for applications that only handle Western European languages and want to minimize bundle size.\n\n## Compatibility\n\n- **Node.js**: v20.0.0 or higher\n- **Browsers**: All modern browsers (Chrome, Firefox, Safari, Edge)\n- **Mobile**: React Native\n- **Other**: Web Workers, CLI\n\n## Installation\n\n### Node.js / React Native\n\n```bash\nnpm install transliteration\n```\n\n\u003e **TypeScript:** Type definitions are bundled with this package. Do not install `@types/transliteration`.\n\n**Quick Start:**\n\n```javascript\nimport { transliterate as tr, slugify } from 'transliteration';\n\n// Transliteration\ntr('你好, world!');  // =\u003e 'Ni Hao , world!'\n\n// Slugify\nslugify('你好, world!');  // =\u003e 'ni-hao-world'\n```\n\n### Browser (CDN)\n\n#### UMD Build (Global Variables)\n\n```html\n\u003cscript src=\"https://cdn.jsdelivr.net/npm/transliteration@2/dist/browser/bundle.umd.min.js\"\u003e\u003c/script\u003e\n\u003cscript\u003e\n  // Available as global variables\n  transliterate('你好, World');  // =\u003e 'Ni Hao , World'\n  slugify('Hello, 世界');       // =\u003e 'hello-shi-jie'\n  \n  // Legacy method (will be removed in next major version)\n  transl('Hola, mundo');       // =\u003e 'hola-mundo'\n\u003c/script\u003e\n```\n\n#### ES Module\n\n```html\n\u003cscript type=\"module\"\u003e\n  import { transliterate } from 'https://cdn.jsdelivr.net/npm/transliteration@2/dist/browser/bundle.esm.min.js';\n  console.log(transliterate('你好'));  // =\u003e 'Ni Hao'\n\u003c/script\u003e\n```\n\n### CLI\n\n```bash\n# Global installation\nnpm install transliteration -g\n\n# Basic usage\ntransliterate 你好                # =\u003e Ni Hao\nslugify 你好                      # =\u003e ni-hao\n\n# Using stdin\necho 你好 | slugify -S           # =\u003e ni-hao\n```\n\n## Usage\n\n### transliterate(str, [options])\n\nConverts Unicode characters in the input string to their Latin equivalents. Unrecognized characters are replaced with the `unknown` placeholder or removed if no placeholder is specified.\n\n#### Options\n\n| Option | Type | Default | Description |\n|--------|------|---------|-------------|\n| `ignore` | `string[]` | `[]` | Strings to preserve without transliteration |\n| `replace` | `object` or `array` | `{}` | Custom replacements applied before transliteration |\n| `replaceAfter` | `object` or `array` | `{}` | Custom replacements applied after transliteration |\n| `trim` | `boolean` | `false` | Trim leading and trailing whitespace from result |\n| `unknown` | `string` | `''` | Replacement character for unrecognized Unicode |\n| `fixChineseSpacing` | `boolean` | `true` | Insert spaces between transliterated Chinese characters |\n\n#### Example\n\n```javascript\nimport { transliterate as tr } from 'transliteration';\n\n// Basic usage\ntr('你好，世界');                  // =\u003e 'Ni Hao , Shi Jie'\ntr('Γεια σας, τον κόσμο');        // =\u003e 'Geia sas, ton kosmo'\ntr('안녕하세요, 세계');             // =\u003e 'annyeonghaseyo, segye'\n\n// With options\ntr('你好，世界', { \n  replace: { 你: 'You' }, \n  ignore: ['好'] \n});                              // =\u003e 'You 好, Shi Jie'\n\n// Array form of replace option\ntr('你好，世界', { \n  replace: [['你', 'You']], \n  ignore: ['好'] \n});                              // =\u003e 'You 好, Shi Jie'\n```\n\n### transliterate.config([optionsObj], [reset = false])\n\nSets global default options for all subsequent `transliterate()` calls. When called without arguments, returns the current configuration. Pass `reset = true` to restore factory defaults.\n\n```javascript\n// Set global configuration\ntr.config({ replace: [['你', 'You']], ignore: ['好'] });\n\n// All calls will use this configuration\ntr('你好，世界');                  // =\u003e 'You 好, Shi Jie'\n\n// View current configuration\nconsole.log(tr.config());        // =\u003e { replace: [['你', 'You']], ignore: ['好'] }\n\n// Reset to defaults\ntr.config(undefined, true);\nconsole.log(tr.config());        // =\u003e {}\n```\n\n### slugify(str, [options])\n\nTransforms Unicode text into a URL-safe and filename-safe slug string.\n\n#### Options\n\n| Option | Type | Default | Description |\n|--------|------|---------|-------------|\n| `ignore` | `string[]` | `[]` | Strings to preserve without transliteration |\n| `replace` | `object` or `array` | `{}` | Custom replacements applied before transliteration |\n| `replaceAfter` | `object` or `array` | `{}` | Custom replacements applied after transliteration |\n| `trim` | `boolean` | `false` | Trim leading and trailing whitespace from result |\n| `unknown` | `string` | `''` | Replacement character for unrecognized Unicode |\n| `lowercase` | `boolean` | `true` | Convert output to lowercase |\n| `uppercase` | `boolean` | `false` | Convert output to uppercase |\n| `separator` | `string` | `-` | Word separator character |\n| `allowedChars` | `string` | `a-zA-Z0-9-_.~'` | Regex character class for permitted characters |\n| `fixChineseSpacing` | `boolean` | `true` | Insert spaces between transliterated Chinese characters |\n\n#### Example\n\n```javascript\n// Basic usage\nslugify('你好，世界');                // =\u003e 'ni-hao-shi-jie'\n\n// With options\nslugify('你好，世界', { \n  lowercase: false, \n  separator: '_' \n});                                // =\u003e 'Ni_Hao_Shi_Jie'\n\n// Using replace option\nslugify('你好，世界', {\n  replace: { \n    你好: 'Hello', \n    世界: 'world' \n  },\n  separator: '_'\n});                                // =\u003e 'hello_world'\n\n// Using ignore option\nslugify('你好，世界', { \n  ignore: ['你好'] \n});                                // =\u003e '你好shi-jie'\n```\n\n### slugify.config([optionsObj], [reset = false])\n\nSets global default options for all subsequent `slugify()` calls. When called without arguments, returns the current configuration. Pass `reset = true` to restore factory defaults.\n\n```javascript\n// Set global configuration\nslugify.config({ lowercase: false, separator: '_' });\n\n// All calls will use this configuration\nslugify('你好，世界');              // =\u003e 'Ni_Hao_Shi_Jie'\n\n// View current configuration\nconsole.log(slugify.config());    // =\u003e { lowercase: false, separator: \"_\" }\n\n// Reset to defaults\nslugify.config(undefined, true);\nconsole.log(slugify.config());    // =\u003e {}\n```\n\n### CLI Usage\n\n#### Transliterate Command\n\n```\ntransliterate \u003cunicode\u003e [options]\n\nOptions:\n  --version      Show version number                                   [boolean]\n  -u, --unknown  Placeholder for unknown characters       [string] [default: \"\"]\n  -r, --replace  Custom string replacement                 [array] [default: []]\n  -i, --ignore   String list to ignore                     [array] [default: []]\n  -S, --stdin    Use stdin as input                   [boolean] [default: false]\n  -h, --help     Show help information                             [boolean]\n\nExamples:\n  transliterate \"你好, world!\" -r 好=good -r \"world=Shi Jie\"\n  transliterate \"你好，世界!\" -i 你好 -i ，\n```\n\n#### Slugify Command\n\n```\nslugify \u003cunicode\u003e [options]\n\nOptions:\n  --version        Show version number                                 [boolean]\n  -U, --unknown    Placeholder for unknown characters     [string] [default: \"\"]\n  -l, --lowercase  Returns result in lowercase         [boolean] [default: true]\n  -u, --uppercase  Returns result in uppercase        [boolean] [default: false]\n  -s, --separator  Separator of the slug                 [string] [default: \"-\"]\n  -r, --replace    Custom string replacement               [array] [default: []]\n  -i, --ignore     String list to ignore                   [array] [default: []]\n  -S, --stdin      Use stdin as input                 [boolean] [default: false]\n  -h, --help       Show help information                           [boolean]\n\nExamples:\n  slugify \"你好, world!\" -r 好=good -r \"world=Shi Jie\"\n  slugify \"你好，世界!\" -i 你好 -i ，\n```\n\n## Known Issues\n\nThis library uses 1-to-1 Unicode code point mapping, which provides broad language coverage but has inherent limitations with context-dependent characters (e.g., polyphonic characters where pronunciation varies by context). Thorough testing with your target languages is recommended before production use.\n\n**Language-Specific Limitations:**\n\n| Language | Issue | Alternative |\n|----------|-------|-------------|\n| **Chinese** | Polyphonic characters may not transliterate correctly | [`pinyin`](https://www.npmjs.com/package/pinyin) |\n| **Japanese** | Kanji characters often convert to Chinese Pinyin due to Unicode overlap | [`kuroshiro`](https://www.npmjs.com/package/kuroshiro) |\n| **Thai** | Not working properly | [Issue #67](https://github.com/yf-hk/transliteration/issues/67) |\n| **Cyrillic** | May be inaccurate for specific languages like Bulgarian | - |\n\nFor other issues or feature requests, please [open an issue](https://github.com/yf-hk/transliteration/issues).\n\n## License\n\nMIT\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyf-hk%2Ftransliteration","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fyf-hk%2Ftransliteration","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyf-hk%2Ftransliteration/lists"}