8000 GitHub - oneElectron/itex at v1.3.1
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

oneElectron/itex

Repository files navigation

ITex

version license GitHub code size in bytes Ubuntu-latest codecov

Initialize a latex project in the current folder

Usage:

itex <options> template
  -i --info                 get template info
  -l --list                 output a list of templates
  -s --disable-os-search    prevent itex from searching the os for the templates folder
  -o --output <path>        output template to given folder <path>
  -u --update               update the itex-templates folder

available templates:

  • default (just the basics with an out folder and a Makefile)
  • iSci
  • apa
  • Electron (My own template)

Install on MacOS

ITex isn't on homebrew's default taps so you need to add my tap then install ITex:

brew tap oneelectron/oneelectron
brew install itex -s

Install on Windows

ITex doesn't have a windows installer yet, so the recommended way is to use cargo to install itex, then use itex to install it's template folder. Install rust then:

cargo install itex
itex --update

Making new templates

To make a new template make a folder where the name of the folder is the template name as this is what ITex uses.

An itex-info.toml is also required with a name and description:

name = "Default"
description = "The default template."

ITex build system

Users can run itex build in order to build their LaTex project. Doing this requires the ITex to know which file to compile, this is specified in the itex-build.toml which looks something like this:

default_filename = "main"
tex_filename = "example.tex"
  • default_filename specifies the base name for any files
  • tex_filename specifies the name of the main tex file. If this option is not specified itex will assume the default_filename + .tex. In this example main.tex

Development

To setup the development environment:

  • Clone the repo
  • Run cargo build in order to install dependencies
0