https://github.com/rreusser/gulp-latex

A gulp plugin for rendering LaTeX files
https://github.com/rreusser/gulp-latex

Last synced: 2 months ago
JSON representation

A gulp plugin for rendering LaTeX files

• Host: GitHub
• URL: https://github.com/rreusser/gulp-latex
• Owner: rreusser
• Created: 2015-07-21T07:55:54.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2015-07-23T05:36:20.000Z (over 9 years ago)
• Last Synced: 2024-10-11T04:03:19.604Z (3 months ago)
• Language: JavaScript
• Size: 114 KB
• Stars: 6
• Watchers: 3
• Forks: 3
• Open Issues: 2
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# gulp-latex [![Build Status](https://travis-ci.org/rreusser/gulp-latex.svg)](https://travis-ci.org/rreusser/gulp-latex) [![npm version](https://badge.fury.io/js/gulp-latex.svg)](http://badge.fury.io/js/gulp-latex) [![Dependency Status](https://david-dm.org/rreusser/gulp-latex.svg)](https://david-dm.org/rreusser/gulp-latex)

A gulp plugin for rendering LaTeX files

## Introduction

This gulp plugin receives .tex files and renders them to .pdf or .dvi files. There's not much more to it than that. It's no more than a wrapper around the [latex](https://github.com/mikolalysenko/node-latex) module, which itself is little more than a wrapper around latex. All options are just passed directly to the latex module.

Sample usage:

```javascript

var latex = require('gulp-latex')

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

  return gulp.src('*.tex')

    .pipe( latex() )

    .pipe( gulp.dest('./') )

})

```

## Installation

As per the [latex](https://github.com/mikolalysenko/node-latex) module instructions, you'll need texlive installed. To install the node module:

```sh

$ npm install gulp-latex

```

## API

### `require('gulp-latex')( options )`

Creates a gulp-compatible object transform stream that inputs and outputs vinyl file objects. Both streamed and buffered I/O is accepted.

- `options`

  - `format`: either 'pdf' or 'dvi. By default outputs a pdf.

  - `command`: the latex command invoked. Default: `latex`

## Testing

Tests are performed using latex/pdflatex stubs in test/stubs. To use your default latex installation, set:

```bash

$ export LATEX=latex

$ export PDFLATEX=pdflatex

```

or whichever commands with which you prefer to invoke latex/pdflatex.

## Credits

(c) 2015 Ricky Reusser. MIT License