unified-latex-stringify v0.2.1
Note This repository is automatically generated from the main parser monorepo. Please submit any issues or pull requests there.
unified-latex-stringify
Plugin for unified-latex
that takes an unified-latex
tree and turns it into 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 unified-latex-stringify
# or with yarn
# yarn add unified-latex-stringify
# or with npm
# npm install unified-latex-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[]): void;
Parameters
Name | Type | Description |
---|---|---|
this | Processor <void , Root , Root , string > | - |
...settings | void [] | Configuration for plugin. Plugins typically receive one options object, but could receive other and more values. Users can also pass a boolean instead of settings: true (to turn a plugin on) or false (to turn a plugin off). When a plugin is turned off, it won’t be called. When creating your own plugins, please accept only a single object! It allows plugins to be reconfigured and it helps users to know that every plugin accepts one options object. |
Returns
void
Plugins can return a Transformer
to specify how the syntax tree is
handled.
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