Absolute Links

Make relative links absolute

Takes a base URL and prepends it to relative links to make them absolute. Relative links are deemed to be those beginning with a /, # or ?.

Install

npm i mkabs --save

For the command line interface install mkdoc globally (npm i -g mkdoc).

Usage

Create the stream and write a commonmark document:

var abs = require('mkabs')
  , ast = require('mkast');
ast.src('[readme](/README.md)')
  .pipe(abs({base: 'https://github.com/mkdoc/mkabs'}))
  .pipe(ast.stringify({indent: 2}))
  .pipe(process.stdout);

API

abs

abs([opts][, cb])

Prepends a base URL to link destinations.

When no base is given an attempt to load package.json from the current working directory is made and a URL is extracted from homepage or repository.url; if there is still no base path then the operation is a passthrough stream (noop).

Returns an output stream.

• opts Object processing options.
• cb Function callback function.

Options

• base String path to prepend to relative links.
• input Readable input stream.
• output Writable output stream.

License

MIT

Generated by mkdoc.