mdast-util-to-string

WebJar for mdast-util-to-string

License	MIT
GroupId	org.webjars.npm
ArtifactId	mdast-util-to-string
Last Version	1.0.7
Release Date	Jan 20, 2020
Type	jar
Description	mdast-util-to-string WebJar for mdast-util-to-string
Project URL	https://www.webjars.org
Source Code Management	https://github.com/syntax-tree/mdast-util-to-string

Download mdast-util-to-string

Filename	Size
mdast-util-to-string-1.0.7.pom
mdast-util-to-string-1.0.7.jar	5 KB
mdast-util-to-string-1.0.7-sources.jar	22 bytes
mdast-util-to-string-1.0.7-javadoc.jar	22 bytes

How to add to project

Apache Maven

<!-- https://jarcasting.com/artifacts/org.webjars.npm/mdast-util-to-string/ -->
<dependency>
    <groupId>org.webjars.npm</groupId>
    <artifactId>mdast-util-to-string</artifactId>
    <version>1.0.7</version>
</dependency>

Gradle Groovy

// https://jarcasting.com/artifacts/org.webjars.npm/mdast-util-to-string/
implementation 'org.webjars.npm:mdast-util-to-string:1.0.7'

Gradle Kotlin

// https://jarcasting.com/artifacts/org.webjars.npm/mdast-util-to-string/
implementation ("org.webjars.npm:mdast-util-to-string:1.0.7")

Apache Buildr

'org.webjars.npm:mdast-util-to-string:jar:1.0.7'

Apache Ivy

<dependency org="org.webjars.npm" name="mdast-util-to-string" rev="1.0.7">
  <artifact name="mdast-util-to-string" type="jar" />
</dependency>

Groovy Grape

@Grapes(
@Grab(group='org.webjars.npm', module='mdast-util-to-string', version='1.0.7')
)

Scala SBT

libraryDependencies += "org.webjars.npm" % "mdast-util-to-string" % "1.0.7"

Leiningen

[org.webjars.npm/mdast-util-to-string "1.0.7"]

Dependencies

There are no dependencies for this project. It is a standalone project that does not depend on any other jars.

Project Modules

There are no modules declared in this project.

mdast-util-to-string

mdast utility to get the plain text content of a node.

Install

npm:

npm install mdast-util-to-string

Use

var unified = require('unified')
var parse = require('remark-parse')
var toString = require('mdast-util-to-string')

var tree = unified()
  .use(parse)
  .parse('Some _emphasis_, **importance**, and `code`.')

console.log(toString(tree)) // => 'Some emphasis, importance, and code.'

API

toString(node)

Get the text content of a node or list of nodes.

The algorithm checks value of node, then alt, and finally title. If no value is found, the algorithm checks the children of node and joins them (without spaces or newlines).

This is not a markdown to plain-text library. Use strip-markdown for that.

Security

Use of mdast-util-to-string does not involve hast, user content, or change the tree, so there are no openings for cross-site scripting (XSS) attacks.

Related

• nlcst-to-string — Get text content in nlcst
• hast-util-to-string — Get text content in hast
• hast-util-to-text — Get text content in hast according to the innerText algorithm
• hast-util-from-string — Set text content in hast

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, organization, or community you agree to abide by its terms.

License

MIT © Titus Wormer

🌲🌲🌲🌳🌲🌳🌲🌲🌲🌳🌳🌲🌲🌳🌲🌲🎄🌲🌳🌲🌲🌳🐻🌳🌳🌳🌲🌲🌳🌲🎄🌲🌳🌲🌲🌳🌳🌳

Versions

Version
1.0.7 Jan 20, 2020
1.0.6 Aug 24, 2019