unist-util-source

Unist utility to get the source of a Node or Location.

Installation

npm:

npm install unist-util-source

Usage

Say we have the following file, example.md:

> + **[Hello](./example)**
>   world.

And our script, example.js, looks as follows:

var vfile = require('to-vfile');
var unified = require('unified');
var parse = require('remark-parse');
var source = require('unist-util-source');

var file = vfile.readSync('example.md');
var tree = unified().use(parse).parse(file);

var list = tree.children[0].children[0];
console.log(source(list, file));

Now, running node example yields:

+ **[Hello](./example)**
  world.

API

source(value, doc)

Parameters

• value (Node or Location) — Value to get
• doc (VFile or string) — Document in which value exists

Returns

string? — Source of value in file, if available.

License

MIT © Titus Wormer