https://github.com/trialanderrororg/rejour-frontmatter
rejourFrontmatter(): Function;
https://github.com/trialanderrororg/rejour-frontmatter
abstract ast syntax tree unified
Last synced: 2 months ago
JSON representation
rejourFrontmatter(): Function;
- Host: GitHub
- URL: https://github.com/trialanderrororg/rejour-frontmatter
- Owner: TrialAndErrorOrg
- Created: 2023-02-28T21:58:01.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-03-14T22:21:28.000Z (about 3 years ago)
- Last Synced: 2025-01-01T04:52:46.600Z (over 1 year ago)
- Topics: abstract, ast, syntax, tree, unified
- Language: TypeScript
- Size: 65.4 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.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
***
### `rejourFrontmatter()`
#### Signature
```ts
rejourFrontmatter(): Function;
```
#### Returns
`Function`
##### `Signature`
```ts
(tree: Root, file: VFile): void;
```
##### `Parameters`
| Name | Type |
| :------ | :------ |
| `tree` | `Root` |
| `file` | `VFile` |
##### `Returns`
`void`
Defined in: [lib/rejour-frontmatter.ts:8](https://github.com/TrialAndErrorOrg/parsers/blob/main/libs/rejour/rejour-frontmatter/src/lib/rejour-frontmatter.ts#L8)
## 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 rejour-frontmatter
# or with yarn
# yarn add rejour-frontmatter
# or with npm
# npm install rejour-frontmatter
```
# rejour-frontmatter
Plugin for `rejour` that parses the frontmatter of a `JATS` document and adds it to the processing VFile as a list of `csl` citations.