GitHub Slugger

Fork of github-slugger written in TS

Demo

GH Pages

Getting Started

1yarn add @caldwell619/github-slugger

Quick Example

1import { slugger } from '@caldwell619/github-slugger'
2
3const slug = slugger('My Cool Post: 2000-08-02')
4// my-cool-post-2000-08-02

Maintaining Casing

By default, all characters will be lower cased. If you wish to maintain the casing, pass the second argument as true:

1import { slugger } from '@caldwell619/github-slugger'
2
3const slug = slugger('My Cool Post: 2000-08-02', true)
4// 'My-Cool-Post-2000-08-02'