/rejour-relatex

Plugin for `rejour` that transforms a `jast` syntax tree into a `texast` syntax tree, allowing for conversion between JATS XML and LaTeX.

Primary LanguageTypeScript

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

rejour-relatex

Plugin for rejour that transforms a jast syntax tree into a texast syntax tree, allowing for conversion between JATS XML and LaTeX.

Contents

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 rejour-relatex
# or with yarn
# yarn add rejour-relatex
# or with npm
# npm install rejour-relatex

Use

API

default()

Plugin to bridge or mutate to relatex

If a destination is given, runs the destination with the new jast tree (bridge-mode). Without destination, returns the jast tree: further plugins run on that tree (mutate-mode).

Signature

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

Parameters

Name Type
this Processor<void, Root, void, void>
...settings [Processor, Options?]

Returns

void | Transformer<Root, Root>

Defined in: node_modules/.pnpm/unified@10.1.2/node_modules/unified/index.d.ts:531

Plugin to bridge or mutate to relatex

If a destination is given, runs the destination with the new jast tree (bridge-mode). Without destination, returns the jast tree: further plugins run on that tree (mutate-mode).

Signature

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

Parameters

Name Type
this Processor<void, Root, void, void>
...settings [Options?]

Returns

void | Transformer<Root, Root>

Defined in: node_modules/.pnpm/unified@10.1.2/node_modules/unified/index.d.ts:531

Syntax tree

Types

Compatibility

Security

Related

Contribute

License

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