https://github.com/devversion/gulp-highlight-files

Gulp plugin to highlight a set of files using HighlightJS
https://github.com/devversion/gulp-highlight-files

gulp gulp-plugin highlight highlightjs node snippets

Last synced: 20 days ago
JSON representation

Gulp plugin to highlight a set of files using HighlightJS

• Host: GitHub
• URL: https://github.com/devversion/gulp-highlight-files
• Owner: devversion
• License: mit
• Created: 2017-02-07T21:22:32.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2021-05-04T16:32:01.000Z (over 3 years ago)
• Last Synced: 2024-11-11T06:12:23.627Z (about 2 months ago)
• Topics: gulp, gulp-plugin, highlight, highlightjs, node, snippets
• Language: JavaScript
• Homepage: https://www.npmjs.com/package/gulp-highlight-files
• Size: 8.79 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# gulp-highlight-files

Gulp plugin to highlight a set of files using [HighlightJS](https://highlightjs.org/).

### Installation

```bash

$ npm install gulp-highlight-files --save-dev

```

### Example

```js

const gulpHighlightFiles = require('gulp-highlight-files');

/* Inside of the gulp task. */

return gulp.src('**/*.html')

  .pipe(gulpHighlightFiles(options)

  .pipe(gulp.dest('dist'));

```

### Configuration

| Name         | Type    | Description                                                     |

|--------------|---------|-----------------------------------------------------------------|

| language     | string  | Explicit language to be used to highlight files.                |

| languageMap  | any     | Object that maps extensions to a specific HighlightJS language. |

| hljsOptions  | any     | Options being passed to HighlightJS.                            |

| ignoreSyntax | boolean | Whether syntax errors should be ignored. Default: `true`.       |