README.md

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

reoff-remark

Plugin for reoff that takes an ooxast tree and turns it into a remark tree, allowing for .docx to .tex conversion

Contents

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

Use

API

---

default()

Plugin to bridge or mutate to remark

If a destination is given, runs the destination with the new mdast tree (bridge-mode). Without destination, returns the jast 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

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 remark

If a destination is given, runs the destination with the new mdast tree (bridge-mode). Without destination, returns the jast 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

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

---

Options

Properties

bibliography?

Data[]

Defined in: libs/ooxast/ooxast-util-to-mdast/src/lib/types.ts:56

bold?

"**" | "__"

Should bold be rendered with * or _?

Default

'**'

Defined in: libs/ooxast/ooxast-util-to-mdast/src/lib/types.ts:46

citationType?

"endnote" | "native" | "mendeley" | "citavi" | "zotero"

What type of citation is used?

Default

'zotero'

Defined in: libs/ooxast/ooxast-util-to-mdast/src/lib/types.ts:51

collectCitation?

Function

Type declaration

Signature`

(citation: any, index: string | number): any;

Parameters`

Name	Type
citation	any
index	string

Returns`

any

Defined in: libs/ooxast/ooxast-util-to-mdast/src/lib/types.ts:53

document?

boolean

Defined in: libs/ooxast/ooxast-util-to-mdast/src/lib/types.ts:36

handlers?

object

Handlers for specific node types

Index signature

Type declaration

Defined in: libs/ooxast/ooxast-util-to-mdast/src/lib/types.ts:35

italics?

"*" | "_"

Should italics be rendered with * or _?

Default

'*'

Defined in: libs/ooxast/ooxast-util-to-mdast/src/lib/types.ts:42

newLines?

boolean

Defined in: libs/ooxast/ooxast-util-to-mdast/src/lib/types.ts:37

parseCitation?

Function

Type declaration

Signature`

(citation: any): any;

Parameters`

Name	Type
citation	any

Returns`

any

Defined in: libs/ooxast/ooxast-util-to-mdast/src/lib/types.ts:52

quotes?

string[]

Defined in: libs/ooxast/ooxast-util-to-mdast/src/lib/types.ts:38

relations?

object

Index signature

Type declaration

Defined in: libs/ooxast/ooxast-util-to-mdast/src/lib/types.ts:54

title?

string

Defined in: libs/ooxast/ooxast-util-to-mdast/src/lib/types.ts:55

Syntax tree

Types

Compatibility

Security

Related

Contribute

License

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