https://github.com/omgimanerd/gulp-pdflatex2
A gulp plugin for compiling .tex files using pdflatex
https://github.com/omgimanerd/gulp-pdflatex2
gulp gulp-pdflatex2 gulp-plugin latex latex-document
Last synced: 2 months ago
JSON representation
A gulp plugin for compiling .tex files using pdflatex
- Host: GitHub
- URL: https://github.com/omgimanerd/gulp-pdflatex2
- Owner: omgimanerd
- License: mit
- Created: 2017-03-31T23:57:51.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2022-11-22T07:24:15.000Z (over 2 years ago)
- Last Synced: 2024-04-24T14:29:34.320Z (about 1 year ago)
- Topics: gulp, gulp-pdflatex2, gulp-plugin, latex, latex-document
- Language: JavaScript
- Homepage:
- Size: 145 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# gulp-pdflatex2
[](https://www.npmjs.com/package/gulp-pdflatex2)
[](https://spdx.org/licenses/MIT)
[]([](https://www.npmjs.com/package/gulp-pdflatex2))
[](https://github.com/omgimanerd/gulp-pdflatex2/pulls)
[](https://github.com/omgimanerd/gulp-pdflatex2/issues)
[](https://github.com/omgimanerd/gulp-pdflatex2/watchers)
[](https://github.com/omgimanerd/gulp-pdflatex2/fork)
gulp-pdflatex2 is a wrapper around `pdflatex` for compiling .tex files into
.pdf files. It is an improved version of
[gulp-pdflatex](https://www.npmjs.com/package/gulp-pdflatex) that displays
LaTeX compilation errors instead of suppressing them.
## Installation
```
npm install --save gulp-pdflatex2
```
## Usage
```javascript
// gulp-rename is not required, but very helpful for redirecting your
// .tex files to a specific output directory.
var gulp = require('gulp');
var rename = require('gulp-rename');
var pdflatex2 = require('gulp-pdflatex2');
gulp.task('latex', () => {
return gulp.src('./*.tex')
.pipe(pdflatex2({
cliOptions: ['-shell-escape'],
keepIntermediateFiles: './tmp',
texInputs: ['./path/to/cls']
}))
.pipe(rename(function(path) {
path.dirname += '/output';
}))
// the compiled pdf file is given to the pipeline
// specify the keepIntermediateFiles option to store intermediate files
.pipe(gulp.dest('./'));
});
```
## Options
- `cliOptions`: optional, pass an additional array of command line options to
the `pdflatex` invocation. Be aware that this package by default specifies
`-file-line-error`, `-halt-on-error`, `-interaction=nonstopmode`
and `-output-directory`. Overwriting these manually will result in unexpected
behavior.
- `keepIntermediateFiles`: optional, pass a directory, relative to the path of
the gulpfile for the intermediate `.aux`, `.log`, `.toc`, and other
miscellaneous files to be stored in.
- `texInputs`: optional, pass an array of directories for pdflatex to look
in for files, useful if you have external class files. This will be used
to populate the TEXINPUTS environment variable. If one is already defined,
then whatever is specified in this option will be appended to the existing
TEXINPUTS environment variable. This is populated by default with the path of
the file being piped to gulp.
## Author
[](http://omgimanerd.tech)
[](https://twitter.com/omgimanerd)
[](https://github.com/omgimanerd)