https://github.com/sindresorhus/gulp-markdown

Markdown to HTML
https://github.com/sindresorhus/gulp-markdown

gulp-plugin html javascript markdown nodejs

Last synced: about 3 hours ago
JSON representation

Markdown to HTML

• Host: GitHub
• URL: https://github.com/sindresorhus/gulp-markdown
• Owner: sindresorhus
• License: mit
• Created: 2013-12-31T01:12:56.000Z (over 10 years ago)
• Default Branch: main
• Last Pushed: 2023-11-03T12:57:46.000Z (11 months ago)
• Last Synced: 2024-04-13T19:53:36.156Z (5 months ago)
• Topics: gulp-plugin, html, javascript, markdown, nodejs
• Language: JavaScript
• Size: 27.3 KB
• Stars: 181
• Watchers: 7
• Forks: 23
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md
  • License: license

Awesome Lists containing this project

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?) (default export)

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

### marked (named export)

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).