@stackline/retext-stringify
v1.0.3
Published
retext plugin to serialize prose
Maintainers
Readme
@stackline/retext-stringify
retext plugin to serialize prose.
Documentation | npm | Issues | Repository
Current package version: 1.0.3
Why this package?
@stackline/retext-stringify is the Stackline-maintained distribution of [email protected]. It is an independent continuation of retext-stringify; original authors and licenses remain credited below.
Compatibility
| Item | Value |
| :--- | :--- |
| Package | @stackline/[email protected] |
| API target | [email protected] |
| Supported Node.js | See supported framework requirements |
| License | MIT |
| Module type | module |
| Main entry | index.js |
| Types | index.d.ts |
| Runtime dependencies | unified, @types/nlcst, nlcst-to-string |
Installation
npm install @stackline/retext-stringifyPreserve existing imports and plugin resolution with an npm alias:
npm install retext-stringify@npm:@stackline/retext-stringifyUsage and API reference
retext-stringify
retext plugin to serialize natural language. Compiler for unified. Serializes nlcst syntax trees.
Sponsors
Support this effort and give back by sponsoring on OpenCollective!
Install
This package is ESM only:
Node 12+ is needed to use it and it must be imported instead of required.
npm:
npm install @stackline/retext-stringifyUse
import {unified} from 'unified'
import {stream} from 'unified-stream'
import retextEnglish from 'retext-english'
import retextStringify from '@stackline/retext-stringify'
import retextEmoji from 'retext-emoji'
const processor = unified()
.use(retextEnglish)
.use(retextEmoji, {convert: 'encode'})
.use(retextStringify)
process.stdin.pipe(stream(processor)).pipe(process.stdout)API
This package exports no identifiers.
retextStringify is the default export.
unified().use(retextStringify)
Serialize nlcst syntax trees. There is no configuration.
Contribute
See contributing.md in retextjs/.github for ways
to get started.
See support.md for ways to get help.
Ideas for new plugins and tools can be posted in retextjs/ideas.
A curated list of awesome retext resources can be found in awesome retext.
This project has a code of conduct. By interacting with this repository, organization, or community you agree to abide by its terms.
License
Credits and original authors
- Original project: retext-stringify.
- Titus Wormer.
- Copyright (c) 2014 Titus Wormer [email protected].
- Stackline maintenance: Alexandro Paixao Marques and Stackline contributors.
Original copyright, license notices and contributor acknowledgements remain part of this distribution. Stackline maintenance does not replace authorship of the original work.
Community and Links
Use this repository's issue tracker for reproducible bugs and feature requests. Join r/Stackline for examples, usage questions and release discussions.
