github-slugger
Generate a slug just like GitHub does for markdown headings.
Last updated a year ago by flet .
ISC · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install github-slugger 
SYNC missed versions from official npm registry.

github-slugger

npm travis

Generate a slug just like GitHub does for markdown headings. It also ensures slugs are unique in the same way GitHub does it. The overall goal of this package is to emulate the way GitHub handles generating markdown heading anchors as close as possible.

Install

npm install github-slugger

Usage

var GithubSlugger = require('github-slugger')
var slugger = new GithubSlugger()

slugger.slug('foo')
// returns 'foo'

slugger.slug('foo')
// returns 'foo-1'

slugger.slug('bar')
// returns 'bar'

slugger.slug('foo')
// returns 'foo-2'

slugger.reset()

slugger.slug('foo')
// returns 'foo'

Check test/index.js for more examples.

Contributing

Contributions welcome! Please read the contributing guidelines first.

License

ISC

Current Tags

  • 1.2.1                                ...           latest (a year ago)

8 Versions

  • 1.2.1                                ...           a year ago
  • 1.2.0                                ...           2 years ago
  • 1.1.3                                ...           3 years ago
  • 1.1.2                                ...           3 years ago
  • 1.1.1                                ...           4 years ago
  • 1.1.0                                ...           4 years ago
  • 1.0.1                                ...           4 years ago
  • 1.0.0                                ...           4 years ago
Downloads
Today 48
This Week 48
This Month 2,877
Last Day 120
Last Week 1,459
Last Month 5,438
Dependencies (1)
Dev Dependencies (4)
Dependents (133)

Copyright 2014 - 2017 © taobao.org |