README.md

Note This repository is automatically generated from the main parser monorepo. Please submit any issues or pull requests there.

relatex-stringify

Plugin for relatex that stringifies a texast syntax tree to a LaTeX file.

Contents

• relatex-stringify
  • Contents
  • What is this?
  • When should I use this?
  • Install
  • Use
  • API
  • Syntax tree
  • Types
  • Compatibility
  • Security
  • Related
  • Contribute
  • License

What is this?

When should I use this?

Install

This package is ESM only. In Node.js (version 12.20+, 14.14+, 16.0+, 18.0+), install as

pnpm add relatex-stringify
# or with yarn
# yarn add relatex-stringify
# or with npm
# npm install relatex-stringify

Use

API

---

default()

A plugin is a function. It configures the processor and in turn can receive options. Plugins can configure processors by interacting with parsers and compilers (at this.Parser or this.Compiler) or by specifying how the syntax tree is handled (by returning a Transformer).

Signature

default(this: Processor<void, Root, Root, string>, ...settings: void[] | [Options]): void;

Parameters

Name	Type	Description
this	Processor<void, Root, Root, string>	-
...settings	void[]	[Options]

Returns

void

Plugins can return a Transformer to specify how the syntax tree is handled.

Defined in: node_modules/.pnpm/[email protected]/node_modules/unified/index.d.ts:531

Syntax tree

Types

Compatibility

Security

Related

Contribute

License

GPL-3.0-or-later © Thomas F. K. Jorna