# @hoast/process-markdown

> Convert markdown to HTML using Unified

Latest version **3.3.1** (published 2024-02-24) · MIT license · 0 weekly downloads

## Install

```sh
npm install @hoast/process-markdown
pnpm add @hoast/process-markdown
yarn add @hoast/process-markdown
bun add @hoast/process-markdown
```

## Health

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

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 3.3.1 |
| Published | 2024-02-24 |
| First published | 2020-10-06 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 8 |
| Unpacked size | 6.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 3 |
| Author | Ron Dekker |
| Maintainers | redkenrok |
| Keywords | hoast, process, markdown |

## Links

- npm: https://www.npmjs.com/package/@hoast/process-markdown
- Repository: https://github.com/hoast/hoast
- Homepage: https://github.com/hoast/hoast/tree/main/packages/process-markdown#readme
- Issues: https://github.com/hoast/hoast/issues
- npm.io page: https://npm.io/package/@hoast/process-markdown

## Dependencies (8)

- [unified](https://npm.io/package/unified.md) ^11.0.4
- [rehype-raw](https://npm.io/package/rehype-raw.md) ^7.0.0
- [@hoast/utils](https://npm.io/package/@hoast/utils.md) ^3.2.0
- [remark-parse](https://npm.io/package/remark-parse.md) ^11.0.0
- [remark-rehype](https://npm.io/package/remark-rehype.md) ^11.1.0
- [rehype-sanitize](https://npm.io/package/rehype-sanitize.md) ^6.0.0
- [rehype-stringify](https://npm.io/package/rehype-stringify.md) ^10.0.0
- [@hoast/base-process](https://npm.io/package/@hoast/base-process.md) ^3.1.0

## Alternatives

- [@mdxeditor/editor](https://npm.io/package/@mdxeditor/editor.md) — 962.4K weekly downloads
- [mmdb-lib](https://npm.io/package/mmdb-lib.md) — 680.9K weekly downloads
- [playcanvas](https://npm.io/package/playcanvas.md) — 36.2K weekly downloads
- [@glw907/cairn-cms](https://npm.io/package/@glw907/cairn-cms.md) — 967 weekly downloads
- [markdown-to-confluence](https://npm.io/package/markdown-to-confluence.md) — 103 weekly downloads

## Recent versions

- 3.3.1 (latest) — 2024-02-24
- 3.3.0 — 2024-02-11
- 3.2.0 — 2024-02-03
- 3.1.2 — 2023-04-07
- 3.1.1 — 2023-04-07
- 3.1.0 — 2023-04-07
- 3.0.2 — 2022-05-30
- 3.0.1 — 2021-07-25
- 3.0.0 — 2021-05-23
- 2.0.0 — 2020-10-06

## README

# @hoast/process-markdown

Convert markdown to HTML using [Unified](https://github.com/unifiedjs/unified#readme).

## Install

```ZSH
npm install @hoast/process-markdown
```

## Options

- `{String} property = 'contents'` Dot notation path to the data property which should be processed as markdown.
- `{Array} remarkPlugins = []` Remark plugins. If the value in the array is an array the first will be instantiated if not already an instance, the subsequent values will be used as the plugin's options.
- `{Array} remarkParseOptions = {}` Options for `remark-parse` plugin.
- `{Array} remarkRehypeOptions = {}` Options for `remark-rehype` plugin.
- `{Array} rehypeRawOptions = {}` Options for `remark-raw` plugin.
- `{Array} rehypePlugins = []` Rehype plugins. If the value in the array is an array the first will be instantiated if not already an instance, the subsequent values will be used as the plugin's options.
- `{Array} rehypeSanitizeOptions = {}` Options for `rehype-sanitize` plugin.
- `{Array} rehypeStringifyOptions = {}` Options for `rehype-stringify` plugin.

- `{Function} filter = null` Custom filter function. The item data is given as the parameter. Return `true` if it should be processed, return `false` if this processor should be skipped.

- `{Number} logLevel = 2` Log level given to the [logger](https://github.com/hoast/hoast/tree/main/packages/utils#logger.js).

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