# github-slugid

> Slugify like GitHub

Latest version **1.0.1** (published 2016-04-04) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install github-slugid
pnpm add github-slugid
yarn add github-slugid
bun add github-slugid
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2016-04-04 |
| First published | 2015-10-21 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 6 |
| Author | Samy Pessé |
| Maintainers | samypesse |

## Links

- npm: https://www.npmjs.com/package/github-slugid
- Repository: https://github.com/SamyPesse/github-slugid
- Homepage: https://github.com/SamyPesse/github-slugid#readme
- Issues: https://github.com/SamyPesse/github-slugid/issues
- npm.io page: https://npm.io/package/github-slugid

## Recent versions

- 1.0.1 (latest) — 2016-04-04
- 1.0.0 — 2015-10-21

## README

# github-slugid

[![NPM version](https://badge.fury.io/js/github-slugid.svg)](http://badge.fury.io/js/github-slugid)
[![Linux Build Status](https://travis-ci.org/SamyPesse/github-slugid.png?branch=master)](https://travis-ci.org/SamyPesse/github-slugid)

Slugify IDs like GitHub.

### Installation

```
npm install github-slugid
```

### Usage

```js
var slug = require('github-slugid');

slug('Hello World') == 'hello-world';
```

[Examples on GitHub](https://gist.github.com/SamyPesse/b3594cc813f026b3fd42)
[Reference](https://github.com/jch/html-pipeline/blob/master/lib/html/pipeline/toc_filter.rb)

---
_Source: https://npm.io/package/github-slugid · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._