https://github.com/rreusser/mdtex-cli

Markdown equation processing as a command line script
https://github.com/rreusser/mdtex-cli

Last synced: 2 months ago
JSON representation

Markdown equation processing as a command line script

• Host: GitHub
• URL: https://github.com/rreusser/mdtex-cli
• Owner: rreusser
• License: isc
• Created: 2015-12-12T23:39:09.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2015-12-12T23:56:06.000Z (about 9 years ago)
• Last Synced: 2024-10-20T12:44:21.722Z (2 months ago)
• Language: JavaScript
• Size: 15.6 KB
• Stars: 8
• Watchers: 4
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# mdtex-cli

> Markdown equation processing as a command line script

## Introduction

This is a convenience wrapper for [gulp-markdown-equations](https://github.com/rreusser/gulp-markdown-equations). That package requires a custom gulpfile in your project, which is a pain. This project takes a simple workflow and wraps it in a cli utility. The result is:



for your markdown documents.

## 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 --imageDirectory ./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] 

  Options:

    -h, --help                   output usage information

    -V, --version                output the version number

    -i, --input            input file

    -o, --output           output file destination

    -d, --imageDirectory   image output destination

```

## License

(c) 2015 Ricky Reusser. ISC License.