Code Monkey home page Code Monkey logo

slugify-path's Introduction

slugify-path

Slugify paths into cool permalinks, mostly for static site generation purposes. You can plug it in during Markdown -> HTML conversion to achieve friendly URLs for static contents.

Install

npm install --save slugify-path

Usage

slugify-path aims to convert a given file path into a friendly URL, making it possible to filter each piece of this path with a given regular expression or string to compare. A piece is delimited by a path separator which defaults to /.

Assuming you have 1.5 Getting Started with Javascript/Introduction/README.md as the path you want to convert, but you want to get rid of that section numbers and that .md from your Markdown files:

// ES2015
import slugifyPath from 'slugify-path';

const greatContentPath = '1.5 Getting Started with Javascript/Introduction/README.md';
const permalink = slugifyPath(greatContentPath, /^\S* |\.md$/);

console.log(permalink); // getting-started-with-javascript/introduction/readme

// ES5
var slugifyPath = require('slugify-path').default;

var greatContentPath = '1.5 Getting Started with Javascript/Introduction/README.md';
var permalink = slugifyPath(greatContentPath, /^\S* |\.md$/);

console.log(permalink); // getting-started-with-javascript/introduction/readme

You can also use a given string for replacement...

console.log(slugifyPath(greatContentPath, 'README.md')) // 1-5-getting-started-with-javascript/introduction/

...or change the path delimiter to whatever works best for you

console.log(slugifyPath('this|path|was oddly splitted|but it|Just works', null, '|')); // this|path|was-oddly-splitted|but-it|just-works

slugify-path's People

Contributors

gmsecrieru avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.