1.1.42 • Published 2 years ago
@technote-space/anchor-markdown-header v1.1.42
anchor-markdown-header
Generates an anchor for a markdown header.
Table of Contents
Install
yarn add @technote-space/anchor-markdown-header
Example
import anchor from '@technote-space/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.
*/
1.1.41
2 years ago
1.1.42
2 years ago
1.1.40
2 years ago
1.1.39
3 years ago
1.1.38
3 years ago
1.1.37
3 years ago
1.1.36
3 years ago
1.1.34
3 years ago
1.1.33
4 years ago
1.1.32
4 years ago
1.1.35
3 years ago
1.1.31
4 years ago
1.1.30
4 years ago
1.1.29
4 years ago
1.1.28
4 years ago
1.1.27
4 years ago
1.1.26
4 years ago
1.1.25
4 years ago
1.1.24
4 years ago
1.1.23
4 years ago
1.1.22
4 years ago
1.1.21
4 years ago
1.1.20
4 years ago
1.1.19
4 years ago
1.1.18
4 years ago
1.1.17
4 years ago
1.1.16
4 years ago
1.1.15
4 years ago
1.1.14
4 years ago
1.1.13
4 years ago
1.1.12
4 years ago
1.1.11
4 years ago
1.1.10
4 years ago
1.1.9
4 years ago
1.1.8
5 years ago
1.1.7
5 years ago
1.1.6
5 years ago
1.1.5
5 years ago
1.1.4
5 years ago
1.1.3
5 years ago
1.1.2
5 years ago
1.1.1
5 years ago
1.1.0
5 years ago
1.0.1
5 years ago