mkref

Link References

Collect link references

Collates link references from all documents in the stream and flushes a paragraph with the link references at the end of the stream.

Install

npm i mkref --save

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

---

• Install
• Usage
• Help
• API
  • ref
    • Options
• License

---

Usage

Create the stream and write a commonmark document:

var ref = require('mkref')
  , ast = require('mkast');
ast.src('[example]: http://example.com')
  .pipe(ref())
  .pipe(ast.stringify({indent: 2}))
  .pipe(process.stdout);

Help

mkref [options]

Link reference collation.

  -h, --help              Display help and exit
  --version               Print the version and exit

Report bugs to https://github.com/mkdoc/mkref/issues

API

ref

ref([opts][, cb])

Gets the link reference collation stream.

Returns an output stream.

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

Options

• input Readable input stream.
• output Writable output stream.

License

MIT

---

Created by mkdoc on April 2, 2016