markdown-anchor

Micro util for creating a markdown-formatted anchor link. Good for linking to code for API docs.

Install with npm

npm i markdown-anchor --save

Usage

var mdanchor = require('markdown-anchor');
mdanchor({
  text; 'embed',
  user; 'assemble',
  repo; 'handlebars-helpers',
  file; 'lib/helpers/code.js',
  line; 'v0.6.0',
  branch; 25
});

//=> [embed](https://github.com/assemble/handlebars-helpers/blob/25/lib/helpers/code.js#Lv0.6.0)

Related projects

• markdown-image: Micro util for generating a single markdown link.
• markdown-link: Micro util for generating a single markdown link.
• markdown-toc: Generate a markdown TOC (table of contents) with Remarkable.
• markdown-utils: Micro-utils for creating markdown snippets.
• remarkable: Markdown parser, done right. 100% Commonmark support, extensions, syntax plugins, high speed - all in one.
• to-gfm-code-block: Generate a github-flavored-markdown fenced code block snippet.

Running tests

Install dev dependencies.

npm i -d && npm test

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue

Author

Jon Schlinkert

• github/jonschlinkert
• twitter/jonschlinkert

License

Copyright (c) 2015 Jon Schlinkert
Released under the MIT license

This file was generated by verb-cli on March 21, 2015.