reoff-rejour v0.1.0

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

reoff-rejour

Plugin for reoff that transforms an ooxast syntax tree into a jats syntax tree, i.e. converting .docx to JATS XML.

Contents

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

Use

API

default()

Plugin to bridge or mutate to jast.

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

This is done so that you can use this plugin as either the plugin before the stringify plugin, or the plugin before another mutate plugin

Signature

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

Parameters

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 jast.

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

This is done so that you can use this plugin as either the plugin before the stringify plugin, or the plugin before another mutate plugin

Signature

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

Parameters

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