markdown-slug

markdown-slug

Slugify the url part of a markdown heading link.

Install

Install with npm:

$ npm install --save markdown-slug

Usage

var slugify = require('markdown-slug');

// forward slashes
console.log(slugify('Some/Article'));
//=> 'somearticle'

// backticks
console.log(slugify('Some`Article`'));
//=> 'somearticle'

// CJK punctuations
console.log(slugify('存在，【中文】；《标点》、符号！的标题？'));
//=> '%E5%AD%98%E5%9C%A8%E4%B8%AD%E6%96%87%E6%A0%87%E7%82%B9%E7%AC%A6%E5%8F%B7%E7%9A%84%E6%A0%87%E9%A2%98'

// &
console.log(slugify('Foo & Bar'));
//=> 'foo--bar'

About

Related projects

• markdown-toc: Generate a markdown TOC (table of contents) with Remarkable. | homepage
• remarkable: Markdown parser, done right. 100% Commonmark support, extensions, syntax plugins, high speed - all in… more | homepage

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Please read the contributing guide for advice on opening issues, pull requests, and coding standards.

Building docs

(This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)

To generate the readme, run the following command:

$ npm install -g verbose/verb#dev verb-generate-readme && verb

Running tests

Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:

$ npm install && npm test

Author

Jon Schlinkert

• github/jonschlinkert
• twitter/jonschlinkert

License

Copyright © 2017, Jon Schlinkert. MIT

This file was generated by verb-generate-readme, v0.4.2, on February 19, 2017.