https://github.com/modood/gulp-markdown-github-style

Markdown to HTML with github style, inspired by gulp-markdown.
https://github.com/modood/gulp-markdown-github-style

github-style gulp gulp-plugin markdown markdown-to-html

Last synced: about 1 month ago
JSON representation

Markdown to HTML with github style, inspired by gulp-markdown.

• Host: GitHub
• URL: https://github.com/modood/gulp-markdown-github-style
• Owner: modood
• License: mit
• Created: 2017-02-17T10:18:13.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2018-01-12T09:01:51.000Z (almost 7 years ago)
• Last Synced: 2024-09-27T03:08:17.212Z (about 2 months ago)
• Topics: github-style, gulp, gulp-plugin, markdown, markdown-to-html
• Language: HTML
• Size: 24.4 KB
• Stars: 10
• Watchers: 3
• Forks: 4
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# gulp-markdown-github-style

[![Deps](https://david-dm.org/modood/gulp-markdown-github-style.svg)](https://david-dm.org/modood/gulp-markdown-github-style)

[![npm](https://img.shields.io/npm/v/gulp-markdown-github-style.svg)](https://www.npmjs.com/package/gulp-markdown-github-style)

[![npm](https://img.shields.io/npm/dt/gulp-markdown-github-style.svg)](https://www.npmjs.com/package/gulp-markdown-github-style)

[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/modood/gulp-markdown-github-style/master/LICENSE)

Markdown to HTML with github style, inspired by gulp-markdown.

## Install

```

$ npm install --save-dev gulp-markdown-github-style

```

## Usage

```js

var gulp = require('gulp');

var markdown = require('gulp-markdown-github-style');

gulp.task('default', function () {

    return gulp.src('README.md').pipe(markdown()).pipe(gulp.dest('dist'));

});

```

## Options

### markdown(options)

See the markdown-it [options](https://github.com/markdown-it/markdown-it#init-with-presets-and-options).

Issues with the output should be reported on the markdown-it [issue tracker](https://github.com/markdown-it/markdown-it/issues).

## Contributing

1. Fork it

2. Create your feature branch (`git checkout -b my-new-feature`)

3. Commit your changes (`git commit -am 'Add some feature'`)

4. Push to the branch (`git push origin my-new-feature`)

5. Create new Pull Request

## License

this repo is released under the [MIT License](http://www.opensource.org/licenses/MIT).