# remarkable-meta

> Add YAML metadata to the remarkable pluggable markdown parser

Latest version **1.0.1** (published 2014-11-24) · BSD-3-Clause license · 0 weekly downloads

## Install

```sh
npm install remarkable-meta
pnpm add remarkable-meta
yarn add remarkable-meta
bun add remarkable-meta
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2014-11-24 |
| First published | 2014-11-24 |
| Weekly downloads | 0 |
| License | BSD-3-Clause |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Eugene Ware |
| Maintainers | eugeneware |
| Keywords | remarkable, remarkable-plugin, meta, metadata, markdown, parser, yaml |

## Links

- npm: https://www.npmjs.com/package/remarkable-meta
- Repository: https://github.com/eugeneware/remarkable-meta
- Issues: https://github.com/eugeneware/remarkable-meta/issues
- npm.io page: https://npm.io/package/remarkable-meta

## Dependencies (1)

- [js-yaml](https://npm.io/package/js-yaml.md) ^3.2.3

## Alternatives

- [monaco-yaml](https://npm.io/package/monaco-yaml.md) — 420.1K weekly downloads
- [@crewx/workflow](https://npm.io/package/@crewx/workflow.md) — 3.1K weekly downloads
- [yaml-cat](https://npm.io/package/yaml-cat.md) — 38 weekly downloads
- [nunjucks-in-yaml](https://npm.io/package/nunjucks-in-yaml.md) — 9 weekly downloads
- [shopify-symlinks](https://npm.io/package/shopify-symlinks.md) — 3 weekly downloads

## Recent versions

- 1.0.1 (latest) — 2014-11-24
- 1.0.0 — 2014-11-24

## README

# remarkable-meta

Add YAML metadata to the remarkable pluggable markdown parser

[![build status](https://secure.travis-ci.org/eugeneware/remarkable-meta.png)](http://travis-ci.org/eugeneware/remarkable-meta)

Based on code by [Alex Kocharin](https://github.com/rlidwka) from [this mailing
list post](https://groups.google.com/forum/#!topic/nodejs/dV6PW3JpYVM).

## Installation

This module is installed via npm:

``` bash
$ npm install remarkable-meta
```

## Example Usage

Given the following markdown file `test.md` with YAML meta data delimited by
`---` placed at the very top of the markdown file:

```
---
My: Word
Author: Eugene
Stuff:
  - My
  - Stuff
---

# My document

## Second heading

This is awesome.

* a point
* another point
```

The YAML front-matter metadata will be available on the markdown object after
parsing when you add the `remarkable-meta` plugin:

``` js
var meta = require('remarkable-meta');
var md = new Remarkable();
md.use(meta);

// Load the file listed above
var file = fs.readFileSync('./test.md', 'uf8');

var html = md.render(mdText);
console.log(md.meta);
// { My: 'Word', Author: 'Eugene', Stuff: [ 'My', 'Stuff' ] }
```

---
_Source: https://npm.io/package/remarkable-meta · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._