unified

Project: syntax-tree/unist-util-source

Package: unist-util-source@2.0.0

  1. Dependencies: 1·Dependents: 10
  2. unist utility to get the source of a value
  1. util 107
  2. utility 105
  3. unist 97
  4. unist-util 24
  5. node 21
  6. position 8
  7. source 3

unist-util-source

Build Coverage Downloads Size Sponsors Backers Chat

unist utility to get the source of a node or at a position.

Install

npm:

npm install unist-util-source

Use

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
Returns

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

Contribute

See contributing.md in syntax-tree/.github for ways to get started. See support.md for ways to get help.

This project has a Code of Conduct. By interacting with this repository, organisation, or community you agree to abide by its terms.

License

MIT © Titus Wormer