0.4.0 • Published 7 months ago
reoff-cite v0.4.0
Note This repository is automatically generated from the main parser monorepo. Please submit any issues or pull requests there.
API
default()
Signature
default(options: Options = ...): Function;
Parameters
Name | Type |
---|---|
options | Options |
Returns
Function
Signature
(tree: Root, vfile: VFile): Root;
Parameters
Name | Type |
---|---|
tree | Root |
vfile | VFile |
Returns
Root
Defined in: lib/reoff-cite.ts:12
Install
This package is ESM only. In Node.js (version 12.20+, 14.14+, 16.0+, 18.0+), install as
pnpm add reoff-cite
# or with yarn
[![npm version](https://badge.fury.io/js/reoff-cite.svg)](https://badge.fury.io/js/reoff-cite) [![npm downloads](https://img.shields.io/npm/dm/reoff-cite.svg)](https://www.npmjs.com/package/reoff-cite)
# yarn add reoff-cite
# or with npm
# npm install reoff-cite
reoff-cite
Plugin for reoff
that parses citations in the form of @cite{key}
and @cite[page]{key}
using ooxast-util-parse-bib
and ooxast-util-parse-text-cite
.
Running unit tests
Run nx test reoff-reoff-cite
to execute the unit tests via Jest.