https://github.com/trialanderrororg/reoff-cite
default(options: Options = ...): Function;
https://github.com/trialanderrororg/reoff-cite
bibliography citation docx ooxast plugin reoff unified
Last synced: 8 months ago
JSON representation
default(options: Options = ...): Function;
- Host: GitHub
- URL: https://github.com/trialanderrororg/reoff-cite
- Owner: TrialAndErrorOrg
- Created: 2023-02-28T21:57:21.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-06-29T17:39:59.000Z (over 1 year ago)
- Last Synced: 2025-01-01T04:52:43.409Z (9 months ago)
- Topics: bibliography, citation, docx, ooxast, plugin, reoff, unified
- Language: TypeScript
- Size: 25.4 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/funding.yml
Awesome Lists containing this project
README
> **Note**
> This repository is automatically generated from the [main parser monorepo](https://github.com/TrialAndErrorOrg/parsers). Please submit any issues or pull requests there.
## API
***
### `default()`
#### Signature
```ts
default(options: Options = ...): Function;
```
#### Parameters
| Name | Type |
| :------ | :------ |
| `options` | `Options` |
#### Returns
`Function`
##### `Signature`
```ts
(tree: Root, vfile: VFile): Root;
```
##### `Parameters`
| Name | Type |
| :------ | :------ |
| `tree` | `Root` |
| `vfile` | `VFile` |
##### `Returns`
`Root`
Defined in: [lib/reoff-cite.ts:12](https://github.com/TrialAndErrorOrg/parsers/blob/main/libs/reoff/reoff-cite/src/lib/reoff-cite.ts#L12)
## Install
This package is [ESM only](https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c). In Node.js (version 12.20+, 14.14+, 16.0+, 18.0+), install as
```bash
pnpm add reoff-cite
# or with yarn
[](https://badge.fury.io/js/reoff-cite) [](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](https://jestjs.io).