package
Generates an anchor for a markdown header.
npm install anchor-markdown-headerGitHub-flavored package documentation.
Across all versions, last 30 days.
936,537 in 30 days
Runtime metadata.
Tagged topics.
Estimated unpacked size across 3 packages.
76.6 kB
Includes dependencies.
Generates an anchor for a markdown header.
var anchor = require('anchor-markdown-header');
anchor('"playerJoined" (player)');
// --> ["playerJoined" (player)](#playerjoined-player)
anchor('fs.rename(oldPath, newPath, [callback])', 'nodejs.org', 'fs')
// --> [fs.rename(oldPath, newPath, [callback])](#fs_fs_rename_oldpath_newpath_callback)
// github.com mode is default
anchor('"playerJoined" (player)') === anchor('"playerJoined" (player)', 'github.com');
// --> trueanchor(header[, mode] [, repetition] [, href])
/**
* @name anchorMarkdownHeader
* @function
* @param header {String} The header to be anchored.
* @param mode {String} The anchor mode (github.com|nodejs.org|bitbucket.org|ghost.org|gitlab.com).
* @param repetition {Number} The nth occurrence of this header text, starting with 0. Not required for the 0th instance.
* @param href {String} The href to be used in the anchor.
* @return {String} The header anchor that is compatible with the given mode.
*/andrewsouthpaw
andrewsmith@alumni.stanford.edu