https://github.com/superraytin/gulp-github-style-page
A gulp plugin for converting markdown content with @github-style-page.
https://github.com/superraytin/gulp-github-style-page
Last synced: 2 months ago
JSON representation
A gulp plugin for converting markdown content with @github-style-page.
- Host: GitHub
- URL: https://github.com/superraytin/gulp-github-style-page
- Owner: superRaytin
- License: mit
- Created: 2015-12-29T14:40:10.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2015-12-30T02:51:49.000Z (over 9 years ago)
- Last Synced: 2025-02-24T05:37:57.103Z (3 months ago)
- Language: JavaScript
- Homepage:
- Size: 4.88 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# gulp-github-style-page
> Converting markdown content with [github-style-page](https://github.com/superRaytin/github-style-page).
[![NPM version][npm-image]][npm-url]
[![Downloads][downloads-image]][npm-url]
[](https://travis-ci.org/superRaytin/gulp-github-style-page)
[](https://npmjs.org/package/gulp-github-style-page)
[npm-url]: https://npmjs.org/package/gulp-github-style-page
[downloads-image]: http://img.shields.io/npm/dm/gulp-github-style-page.svg
[npm-image]: http://img.shields.io/npm/v/gulp-github-style-page.svg
# Installation
```
npm install gulp gulp-github-style-page --save-dev
```
# Quick Start
```js
var gulp = require('gulp');
var githubStylePage = require('gulp-github-style-page');
gulp.task('taskName', function() {
return gulp.src('path/to/README.md')
.pipe(githubStylePage())
.pipe(gulp.dest('dist'));
});
```
Customize template:
```js
gulp.task('taskName2', function() {
return gulp.src('path/to/README.md')
.pipe(githubStylePage({
customizeTemplatePath: 'path/to/customTemplate.html',
vars: {
t: 'awesome',
v: '0.1.2'
}
}))
.pipe(gulp.dest('dist'));
});
```
Use built-in template:
```js
gulp.task('taskName3', function() {
return gulp.src('path/to/README.md')
.pipe(githubStylePage({
template: 'project',
vars: {
pkg: {
name: 'awesome',
version: '0.1.0'
},
examples: ['simple', 'complex']
}
}))
.pipe(gulp.dest('dist'));
});
```
## Options
See [github-style-page#options](https://github.com/superRaytin/github-style-page#options) for detail.
# Testing
```
npm test
```
# License
MIT, see the [LICENSE](/LICENSE) file for detail.