https://github.com/einar-hjortdal/slugify

Generate slug from string, includes custom and language-specific transliterations
https://github.com/einar-hjortdal/slugify

Last synced: 5 days ago
JSON representation

Generate slug from string, includes custom and language-specific transliterations

• Host: GitHub
• URL: https://github.com/einar-hjortdal/slugify
• Owner: einar-hjortdal
• License: ncsa
• Created: 2023-06-13T13:03:23.000Z (over 1 year ago)
• Default Branch: live
• Last Pushed: 2024-12-07T08:04:13.000Z (about 2 months ago)
• Last Synced: 2024-12-07T08:24:59.904Z (about 2 months ago)
• Language: V
• Homepage:
• Size: 28.3 KB
• Stars: 3
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md

Awesome Lists containing this project

• awesome-v - slugify - Transform Unicode strings to url-friendly human-readable ASCII slugs. (Libraries / Text processing)

README

        
# slugify

Generate slug from string

## Features

- language-specific transliteration toggle

- custom replacement map support

- truncate at maximum character length

- truncate at the end of a word before given maximum character length

- transform to lowercase toggle

## Usage

Install with `v install einar-hjortdal.slugify`

```V

import einar_hjortdal.slugify

slugifier := slugify.default()

slug := slugifier.make('Slugs are NOT snails') // slugs-are-not-snails

```

Please refer to [slugify_test.v](./slugify_test.v) for more information.

## Notes

`make` and `make_lang` return a string that:

- contains exclusively word characters (`\w`) and hyphens (`-`).

- does not start nor end with hyphens (`-`) or underscores (`_`).

- **may be empty**: if the given string contains exclusively non-word characters and those characters 

are not contained in the `substitutions.v` file.

Pull requests are welcome to add support for more languages. To add subsitutions or a whole new language, 

please look at the [substitutions.v](./substitutions.v) file and at the [CONTRIBUTING.md](./CONTRIBUTING.md) 

file.