txmanipulator v3.0.2

About The project

This project aims to automate the process of creating Anki cards. To create cards, in batch, you can write a simple LaTeX document which is then transformed into markdown and csv file. The latter is used to be imported into Anki. The former is simplified LaTeX document for reading without compiler LaTeX document.

Template

Easy to use command line interface for creating a template that is used to batch write Anki cards in LaTeX format. Although not necessary, yet very handy and time saving.

Manipulator

Command line interface that transforms LaTeX document into markdown and csv files or simply markdown to csv. The goal of this program is making process of creating Anki cards easier and faster by writing Anki card in a simgle file which can be easily modified and searched for changes and automatically calling Anki for import. Windows users require for auto importing set Anki environmental variable.

Built with

• Node.js
• TypeScript
• commander.js

Getting started

To get started you need installed Node.js LTS 14.x or later alongsite other tools.

Prerequisites

• Node.js LTS 14.x or later
• TypeScript

Installation

1. Install Node.js
2. Clone the repo

git clone https://github.com/janmerhar/LaTeX_manipulator

3. Install NPM packages

npm install

4. Install TypeScript

npm install typescript -g

5. Run TypeScript compiler

npm run compile

Usage

Scripts are located in execs folder. You can run them with node. Note, you need to compile TypeScript into JavaScript before you can run them.

Template CLI

Usage: template [options]

Options:
  -f, --file-name <strings...>  Name of the LaTeX output file
  -t, --title <string...>       Title given by the user
  -d, --date <strings...>         Date given by the user (default: "2021-07-27")
  -a, --author <strings...>     Author(s) (default: "")
  -p, --packages <strings...>   packages added to \usepackage
  -s, --sections <number>       Number of sections in the document
  -h, --help                    display help for command

Manipulator CLI

Usage: manipulator [options]

Options:
  -i, --input <string>           Name of file that will be imported
  -tof, --type-of-file <number>  1 => MD file, 2 => CSV file, 3 => MD and CSV
                                 file (default: "3")
  -at, --anki-tag <string>       Input tag field value for imported document:
                                 eg. OMA-13
  -f, --file-name <string>       Name of the output file
  -r, --run <number>             1 => runs manipulated data in program,  0 =>
                                 doesn't run anything (default: "1")
  -h, --help                     display help for command