# markdown-it-meta

> Markdown-it Metadata as yaml for markdown documents

Latest version **0.0.1** (published 2017-02-28) · MIT license · 0 weekly downloads

## Install

```sh
npm install markdown-it-meta
pnpm add markdown-it-meta
yarn add markdown-it-meta
bun add markdown-it-meta
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.1 |
| Published | 2017-02-28 |
| First published | 2017-02-28 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | scott-wyatt |
| Maintainers | scottbwyatt |
| Keywords | markdown-it, yaml, metadata, markdown |

## Links

- npm: https://www.npmjs.com/package/markdown-it-meta
- npm.io page: https://npm.io/package/markdown-it-meta

## Dependencies (1)

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

## 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

- 0.0.1 (latest) — 2017-02-28

## README

# Markdown-it-meta
Markdown-it plugin to add YAML metadata

## Install
```sh
$ npm install markdown-it-meta --save
```

## Use
```js
const MarkdownIt = require('markdown-it')
const meta = require('markdown-it-meta')

// Make new instance
const md = new MarkdownIt()
// Add markdown-it-meta
md.use(meta)

const renderedDocument =  md.render('<md with YAML>')
return {
  document: renderedDocument,
  meta: md.meta
}
```

## Features
Adds YAML to markdown documents to be used as meta data.
- Make Strings
- Make Arrays
- Make Objects
- All YAML is valid

## Markdown

```
---
title: Welcome to Markdown-it-meta
keywords: markdown-it-meta
runs: 0
score: 0.0
demographics:
 - {name: 'unknown'}
---
## Hello World
```

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