https://github.com/simbo/gulp-marked
Convert markdown files to html with marked
https://github.com/simbo/gulp-marked
Last synced: 12 months ago
JSON representation
Convert markdown files to html with marked
- Host: GitHub
- URL: https://github.com/simbo/gulp-marked
- Owner: simbo
- Created: 2013-12-05T15:10:37.000Z (over 12 years ago)
- Default Branch: master
- Last Pushed: 2020-07-15T20:01:03.000Z (almost 6 years ago)
- Last Synced: 2024-04-14T22:21:16.746Z (about 2 years ago)
- Language: JavaScript
- Size: 14.6 KB
- Stars: 22
- Watchers: 5
- Forks: 11
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
gulp-marked
===========
> **DEPRECATED**
> Please use [gulp-markdown](https://www.npmjs.com/package/gulp-markdown).
---
## Information
Packagegulp-marked
Description
Convert markdown files to html with marked.
Node Version
≥ 0.10
## Usage
In a Gulp task:
```javascript
var marked = require('gulp-marked');
gulp.task('convert', function() {
gulp.src('./src/*.md')
.pipe(marked({
// optional : marked options
}))
.pipe(gulp.dest('./html/'))
});
```
In your own Gulp plugin:
```js
var markedTransform = require('gulp-marked').fileTransform;
file.contents = file.contents.pipe(markedTransform(options));
// Then pipe you own contents in
```
## LICENSE
(MIT License)
> Copyright (c) 2013 Thomas Moyse
>
> Permission is hereby granted, free of charge, to any person obtaining
> a copy of this software and associated documentation files (the
> "Software"), to deal in the Software without restriction, including
> without limitation the rights to use, copy, modify, merge, publish,
> distribute, sublicense, and/or sell copies of the Software, and to
> permit persons to whom the Software is furnished to do so, subject to
> the following conditions:
>
> The above copyright notice and this permission notice shall be
> included in all copies or substantial portions of the Software.
>
> THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
> EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
> MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
> NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
> LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
> OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
> WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.