# gulp-markdown

> Markdown to HTML

Latest version **8.0.0** (published 2023-11-03) · MIT license · 0 weekly downloads

## Install

```sh
npm install gulp-markdown
pnpm add gulp-markdown
yarn add gulp-markdown
bun add gulp-markdown
```

## Health

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

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 8.0.0 |
| Published | 2023-11-03 |
| First published | 2013-12-31 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM |
| Node | >=18 |
| Dependencies | 2 |
| Unpacked size | 3.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 182 |
| Author | Sindre Sorhus |
| Maintainers | sindresorhus |
| Keywords | gulpplugin, markdown, marked, md, compile, convert, markup, html |

## Links

- npm: https://www.npmjs.com/package/gulp-markdown
- Repository: https://github.com/sindresorhus/gulp-markdown
- Homepage: https://github.com/sindresorhus/gulp-markdown#readme
- Issues: https://github.com/sindresorhus/gulp-markdown/issues
- Funding: https://github.com/sponsors/sindresorhus
- npm.io page: https://npm.io/package/gulp-markdown

## Dependencies (2)

- [marked](https://npm.io/package/marked.md) ^9.1.5
- [gulp-plugin-extras](https://npm.io/package/gulp-plugin-extras.md) ^0.3.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

- 8.0.0 (latest) — 2023-11-03
- 7.0.0 — 2022-06-10
- 6.0.0 — 2021-03-01
- 5.1.0 — 2020-07-12
- 5.0.1 — 2019-10-04
- 5.0.0 — 2019-08-18
- 4.0.0 — 2019-04-11
- 3.0.0 — 2018-08-08
- 2.0.1 — 2017-12-31
- 2.0.0 — 2017-12-31
- 1.2.0 — 2015-11-14
- 1.1.0 — 2015-10-04
- 1.0.0 — 2014-08-14
- 0.2.0 — 2014-07-26
- 0.1.2 — 2014-01-19
- … 2 more at https://npm.io/package/gulp-markdown/versions

## README

# gulp-markdown

> Markdown to HTML with [`marked`](https://github.com/markedjs/marked)

*Issues with the output should be reported on the `marked` [issue tracker](https://github.com/markedjs/marked/issues).*

## Install

```sh
npm install --save-dev gulp-markdown
```

## Usage

```js
import gulp from 'gulp';
import markdown from 'gulp-markdown';

export default () => (
	gulp.src('intro.md')
		.pipe(markdown())
		.pipe(gulp.dest('dist'))
);
```

## API

### markdown(options?) <sup>(default export)</sup>

See the `marked` [options](https://marked.js.org/using_advanced#options).

### marked <sup>(named export)</sup>

Access the `marked` object to customize the [lexer](https://marked.js.org/using_pro#lexer), [parser](https://marked.js.org/using_pro#parser) or [renderer](https://marked.js.org/using_pro#renderer).

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