# gulp-latex

> A gulp plugin for rendering LaTeX files

Latest version **1.0.1** (published 2015-07-23) · MIT license · 0 weekly downloads

## Install

```sh
npm install gulp-latex
pnpm add gulp-latex
yarn add gulp-latex
bun add gulp-latex
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2015-07-23 |
| First published | 2015-07-21 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 6 |
| Author | Ricky Reusser |
| Maintainers | rreusser |
| Keywords | gulpplugin, latex, tex |

## Links

- npm: https://www.npmjs.com/package/gulp-latex
- Repository: https://github.com/rreusser/gulp-latex
- Homepage: https://github.com/rreusser/gulp-latex#readme
- Issues: https://github.com/rreusser/gulp-latex/issues
- npm.io page: https://npm.io/package/gulp-latex

## Dependencies (4)

- [latex](https://npm.io/package/latex.md) 0.0.1
- [raw-body](https://npm.io/package/raw-body.md) ^2.1.2
- [through2](https://npm.io/package/through2.md) ^2.0.0
- [gulp-util](https://npm.io/package/gulp-util.md) ^3.0.6

## Alternatives

- [ext-list](https://npm.io/package/ext-list.md) — 6.3M weekly downloads
- [@lexical/selection](https://npm.io/package/@lexical/selection.md) — 3.8M weekly downloads
- [@lexical/text](https://npm.io/package/@lexical/text.md) — 3.6M weekly downloads
- [@lexical/clipboard](https://npm.io/package/@lexical/clipboard.md) — 3.0M weekly downloads
- [@tiptap/extension-mention](https://npm.io/package/@tiptap/extension-mention.md) — 3.0M weekly downloads

## Recent versions

- 1.0.1 (latest) — 2015-07-23
- 1.0.0 — 2015-07-23
- 0.1.3 — 2015-07-23
- 0.1.2 — 2015-07-21
- 0.1.1 — 2015-07-21
- 0.1.0 — 2015-07-21

## 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

---
_Source: https://npm.io/package/gulp-latex · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._