Follow us on TwitterFork us on GitHub

Command Line

jtex can be used as a package as well as a command-line interface. It is most common that you will be using jtex as a component of the myst ecosystem, however, if you are contributing or building your own template locally, there are a number of tools that can help you validate and build your template.yml. To install the command line tools use:

npm install -g jtex

#Rendering

To render a template, you need to have the template directory defined, as well as content.tex and a frontmatter.yml.

jtex render content.tex output/folder --frontmatter ./frontmatter.yml --template my/template/folder

#Building Templates

#jtex check [folder] [--fix]

Without a folder, it will use the current directory. You can use the --fix argument to automatically add packages and known arguments to your template.yml.

jtex check arxiv_two_column
> template.yml
>   [parts.0] 'parts.0' extra key ignored: chars
> template.tex
>   [options] The following options were not referenced in the template: "show_date"
>   [options] The template.yml does not include "watermark" but it is referenced in template.tex on line 57
> jtex found warnings or errors in validating your template.

#jtex parse [file]

To see the contents of your template that are rendered.

jtex parse arxiv_two_column/template.tex
> Doc:
>     title                         line 53
>     authors                       lines 72, 75
>     keywords                      lines 95, 96
>
> Options:
>     watermark                     line 57
>     link                          lines 116, 119
>
> Parts:
>     abstract                      lines 89, 91
>     acknowledgments               lines 108, 112
>
> Packages:
>     preprint                      line 2
>     lipsum                        line 3
>     amsthm                        line 19
>     fontenc                       line 20

#jtex list

List all known public templates.

jtex list
> EarthArXiv (Two Column)  eartharxiv_two_column
>     Description: A two column preprint template for EarthArXiv with the AGU bibstyle
>     Tags: paper, two-column, geoscience, earthscience, preprint
>
> arXiv (Two Column)       arxiv_two_column
>     Description: A two column arXiv compatible template
>     Tags: paper, two-column, preprint, arxiv, bioarxiv, eartharxiv

You can also filter by --tag two-column or any comma seperated tags that will be used to filter the list.

#jtex list [template]

To find the details on a single template use:

jtex list volcanica
> Volcanica                volcanica
> ID: public/volcanica
> Version: 1.0.0
> Author: Volcanica
> Description: A template for submissions to the Volcanica journal
> Tags: paper, journal, two-column, geoscience, earthscience