You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+28-19Lines changed: 28 additions & 19 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,7 +16,7 @@ Each input is provided as a key inside the `with` section of the action.
16
16
17
17
The root LaTeX file to be compiled. This input is required. You can also pass multiple files as a multi-line string to compile multiple documents. For example:
18
18
```yaml
19
-
- uses: xu-cheng/latex-action@v2
19
+
- uses: xu-cheng/latex-action@v3
20
20
with:
21
21
root_file: |
22
22
file1.tex
@@ -27,7 +27,7 @@ Each input is provided as a key inside the `with` section of the action.
27
27
28
28
If set, interpret the `root_file` input as bash glob pattern. For example:
29
29
```yaml
30
-
- uses: xu-cheng/latex-action@v2
30
+
- uses: xu-cheng/latex-action@v3
31
31
with:
32
32
root_file: "*.tex"
33
33
glob_root_file: true
@@ -61,7 +61,7 @@ Each input is provided as a key inside the `with` section of the action.
61
61
62
62
Install extra `.ttf`/`.otf` fonts to be used by `fontspec`. You can also pass multiple files as a multi-line string. Each file path will be interpreted as glob pattern. For example:
63
63
```yaml
64
-
- uses: xu-cheng/latex-action@v2
64
+
- uses: xu-cheng/latex-action@v3
65
65
with:
66
66
root_file: main.tex
67
67
extra_fonts: |
@@ -77,6 +77,26 @@ Each input is provided as a key inside the `with` section of the action.
77
77
78
78
Arbitrary bash codes to be executed after compiling LaTeX documents. For example, `post_compile: "latexmk -c"` to clean up temporary files.
79
79
80
+
* `texlive_version`
81
+
82
+
The version of TeXLive to be used. Supported inputs include 2020, 2021, 2022, 2023, and latest. By default the latest TeXLive is used. This input cannot co-exist with `docker_image` input. An example to use this input:
83
+
```yaml
84
+
- uses: xu-cheng/latex-action@v3
85
+
with:
86
+
root_file: main.tex
87
+
texlive_version: 2022
88
+
```
89
+
90
+
* `docker_image`
91
+
92
+
Custom which docker image to be used. Only [latex-docker images](https://github.com/xu-cheng/latex-docker/pkgs/container/texlive-full) are supported. For example if you want to pin the docker image:
**The following inputs are only valid if the input `compiler` is not changed.**
81
101
82
102
* `latexmk_shell_escape`
@@ -103,7 +123,7 @@ jobs:
103
123
- name: Set up Git repository
104
124
uses: actions/checkout@v3
105
125
- name: Compile LaTeX document
106
-
uses: xu-cheng/latex-action@v2
126
+
uses: xu-cheng/latex-action@v3
107
127
with:
108
128
root_file: main.tex
109
129
- name: Upload PDF file
@@ -120,14 +140,14 @@ jobs:
120
140
By default, this action uses pdfLaTeX. If you want to use XeLaTeX or LuaLaTeX, you can set the `latexmk_use_xelatex` or `latexmk_use_lualatex` input respectively. For example:
121
141
122
142
```yaml
123
-
- uses: xu-cheng/latex-action@v2
143
+
- uses: xu-cheng/latex-action@v3
124
144
with:
125
145
root_file: main.tex
126
146
latexmk_use_xelatex: true
127
147
```
128
148
129
149
```yaml
130
-
- uses: xu-cheng/latex-action@v2
150
+
- uses: xu-cheng/latex-action@v3
131
151
with:
132
152
root_file: main.tex
133
153
latexmk_use_lualatex: true
@@ -140,7 +160,7 @@ Alternatively, you could create a `.latexmkrc` file. Refer to the [`latexmk` doc
140
160
To enable `--shell-escape`, set the `latexmk_shell_escape` input.
141
161
142
162
```yaml
143
-
- uses: xu-cheng/latex-action@v2
163
+
- uses: xu-cheng/latex-action@v3
144
164
with:
145
165
root_file: main.tex
146
166
latexmk_shell_escape: true
@@ -172,7 +192,7 @@ Sometimes you may have custom package (`.sty`) or class (`.cls`) files in other
172
192
run: |
173
193
curl -OL https://example.com/custom_template.zip
174
194
unzip custom_template.zip
175
-
- uses: xu-cheng/latex-action@v2
195
+
- uses: xu-cheng/latex-action@v3
176
196
with:
177
197
root_file: main.tex
178
198
env:
@@ -183,17 +203,6 @@ Noted that you should NOT use `{{ github.workspace }}` or `$GITHUB_WORKSPACE` in
183
203
184
204
You can find more information of `TEXINPUTS` [here](https://tex.stackexchange.com/a/93733).
185
205
186
-
### How to use old versions of TeXLive?
187
-
188
-
By default, this action always uses the latest docker image that contains the latest TeXLive updates. If you want to use old versions of TeXLive, you can change the action version tag accordingly. Currently, three last old versions of TeXLive are supported.
This is an upstream issue where `xindy.x86_64-linuxmusl` is currently missing in TeXLive. To work around it, try [this](https://github.com/xu-cheng/latex-action/issues/32#issuecomment-626086551).
0 commit comments