# mdtex-cli

> Markdown equation processing as a command line script

Latest version **0.0.3** (published 2015-12-12) · ISC license · 0 weekly downloads

## Install

```sh
npm install mdtex-cli
pnpm add mdtex-cli
yarn add mdtex-cli
bun add mdtex-cli
```

Provides the command `mdtex`.

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.3 |
| Published | 2015-12-12 |
| First published | 2015-12-12 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 13 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 8 |
| Author | Ricky Reusser |
| Maintainers | rreusser |
| Keywords | markdown, latex, equations |

## Links

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

## Dependencies (13)

- [gulp](https://npm.io/package/gulp.md) ^3.9.0
- [hasbin](https://npm.io/package/hasbin.md) ^1.1.3
- [gulp-tap](https://npm.io/package/gulp-tap.md) ^0.1.3
- [commander](https://npm.io/package/commander.md) ^2.9.0
- [gulp-util](https://npm.io/package/gulp-util.md) ^3.0.7
- [gulp-count](https://npm.io/package/gulp-count.md) ^0.1.0
- [gulp-latex](https://npm.io/package/gulp-latex.md) ^1.0.1
- [gulp-shell](https://npm.io/package/gulp-shell.md) ^0.5.1
- [gulp-spawn](https://npm.io/package/gulp-spawn.md) ^0.3.0
- [gulp-filter](https://npm.io/package/gulp-filter.md) ^3.0.1
- [gulp-rename](https://npm.io/package/gulp-rename.md) ^1.2.2
- [gulp-pdftocairo](https://npm.io/package/gulp-pdftocairo.md) ^0.2.0
- [gulp-markdown-equations](https://npm.io/package/gulp-markdown-equations.md) ^1.2.3

## Alternatives

- [@mdxeditor/editor](https://npm.io/package/@mdxeditor/editor.md) — 962.4K weekly downloads
- [mmdb-lib](https://npm.io/package/mmdb-lib.md) — 680.9K weekly downloads
- [playcanvas](https://npm.io/package/playcanvas.md) — 36.2K weekly downloads
- [@glw907/cairn-cms](https://npm.io/package/@glw907/cairn-cms.md) — 967 weekly downloads
- [markdown-to-confluence](https://npm.io/package/markdown-to-confluence.md) — 103 weekly downloads

## Recent versions

- 0.0.3 (latest) — 2015-12-12
- 0.0.1 — 2015-12-12

## README

# mdtex-cli

> Markdown equations as a command line script

## Introduction

This is a convenience wrapper for [gulp-markdown-equations](https://github.com/rreusser/gulp-markdown-equations). That packages requires a custom gulpfile in your project with all oft he custom setup. That's nice, but it's a pain. This project takes a simple workflow and wraps it in a cli utility. The result is:

<p align="center"><img alt="simple&bsol;&semi;&bsol;LaTeX&bsol;&semi;typesetting&period;" valign="middle" src="images/simplelatextypesetting-95e156e622.png" width="234.5" height="32.5"></p>

## Installation

```bash
$ npm install -g mdtex-cli
```

## Examples

Process all files matching `*.mdtex` in the current directory, outputting them as `*.md` and equations into `./images`:

```bash
$ mdtex
```

Process a specific file:

```bash
$ mdtex README.mdtex --output README.md --imageDir ./image-files
```

## Requirements

You will need the following commands accessible in your `PATH` variable in order to use this utility:

- `pdflatex`
- `convert` (optional for trimming, part of the ImageMagick suite)
- `pdftocairo` (part of the [Poppler](http://poppler.freedesktop.org/) package)

## Usage

```
$ mdtex --help

  Usage: cli [options] <file ...>

  Options:

    -h, --help                   output usage information
    -V, --version                output the version number
    -i, --input <file>           input file
    -o, --output <file>          output file destination
    -d, --imageDirectory <path>  image output destination
```

## License

(c) 2015 Ricky Reusser. ISC License.

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