0.7.0 • Published 1 year ago
anchor-markdown-header v0.7.0
anchor-markdown-header
Generates an anchor for a markdown header.
Example
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');
// --> true
API
anchor(header[, mode] [, moduleName] [, repetition)
/**
* @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 moduleName {String} The name of the module of the given header (required only for 'nodejs.org' mode).
* @return {String} The header anchor that is compatible with the given mode.
*/
0.7.0
1 year ago
0.6.0
2 years ago
0.5.7
7 years ago
0.5.6
7 years ago
0.5.5
8 years ago
0.5.4
9 years ago
0.5.3
9 years ago
0.5.2
9 years ago
0.5.1
9 years ago
0.5.0
9 years ago
0.4.1
9 years ago
0.4.0
10 years ago
0.3.8
10 years ago
0.3.7
10 years ago
0.3.6
10 years ago
0.3.5
10 years ago
0.3.4
10 years ago
0.3.3
10 years ago
0.3.2
11 years ago
0.3.1
11 years ago
0.3.0
11 years ago
0.2.1
11 years ago
0.2.0
11 years ago
0.1.2
11 years ago
0.1.1
11 years ago