Terfno / ReXeTeXeR

XeTeX on Docker based Alpine. / Makefiles for easy operation and a shell script for automated monitoring builds. / With documentation for beginners.

Home Page:https://hub.docker.com/r/terfno/rexetexer

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

GitHub GitHub repo size GitHub last commit


img

awesome cool logo

What is this?

img

It compiles Japanese (you can use English) TeX file to PDF without TeX Live on your local machine. Just required Docker. It includes BibTeX.

variation

Environment

  • Required
    • Docker (or Podman)
  • Optional
    • GNU Make
    • Text editor
    • PDF viewer (Skim)

How to use

0. Preparation

Download the latest version from releases. Then, unzip the .zip file.

.
├── LICENSE
├── Makefile
├── NotoSansJP-Regular.otf
├── NotoSerifJP-Regular.otf
├── README.md
├── RobotoMono.ttf
├── img
│   └── logo.png
├── ref.bib
├── report.pdf
├── report.tex
└── watch.sh

After that, run the below command at the directory where you unzip.

$ make init

If you want to use Podman.

If you want to use Podman, you should read and run as follows.

# General
$ make podman.${TARGET}

# Example: Run `make init` with Podman
$ make podman.init

1. Launch

$ make run

2. Connect

$ make exec

After running this command, your terminal will connect to the container. The following commands are executed in a container.

3. Launch auto compile script

$ make watch

If you want to compile just 1 time.

$ make tex

4. Write TeX

After make watch, edit . /report.tex will automatically generate a pdf. TeX Engine is XeTeX/XeLaTeX, see ./report.tex.

5. View PDF

Open ./report.pdf with Skim or your favorite PDF viewer.

6. Tips

Can be incompatible with AutoSave (VS Code)

AutoSave, such as VS Code, can cause incomplete .tex files to be compiled because it detects changes in the file and runs the compilation.

This can be resolved by setting .vscode to set AutoSave to onFocusChange for this workspace only. Or you can also solve this problem by extending the monitoring interval of watch.sh from 1 to about 5 seconds.

PDF Viewer that supports auto-reload of resources

If you want to stop this system.

Exit container($ exit), and do the below commands.

$ make stop

If you want to relaunch the system, use $ make start.

If you want to delete the container, do the below commands. (It does not delete the image. Safe.)

$ make rm

If you want to delete the image, do the below commands.

$ make rmi

thx

Support me!

Buy Me A Coffee

About

XeTeX on Docker based Alpine. / Makefiles for easy operation and a shell script for automated monitoring builds. / With documentation for beginners.

https://hub.docker.com/r/terfno/rexetexer

License:MIT License


Languages

Language:TeX 99.2%Language:Makefile 0.5%Language:Shell 0.2%Language:Dockerfile 0.1%