A simple script to generate table of contents links for GitHub flavoured markdown docs

toc.js

/**
 *  A simple script to generate table of contents links for GitHub flavoured markdown docs
 */

const makeAnchor = val => val.trim().toLowerCase().replace(/[^\w\- ]+/g, '').replace(/\s/g, '-').replace(/\-+$/, '')

// paths that end with / need a trailing -
const wrap = val => val.endsWith('/')
  ? `[\`${val}\`](#${makeAnchor(val)}-)`
  : `[\`${val}\`](#${makeAnchor(val)})`

// put your headers in here
const routes = [
  'GET /',
  'GET /ping',
  'GET /api/v1/some/:excellent/:route',
].map(wrap)

console.log('* ' + routes.join('\n* '))

/*

  emits

* [`GET /`](#get-)
* [`GET /ping`](#get-ping)
* [`GET /api/v1/some/:excellent/:route`](#get-apiv1someexcellentroute)

*/