Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hspaans/latexmk-action
GitHub Action for generating a PDF from LaTeX
https://github.com/hspaans/latexmk-action
document github-action latex pdf
Last synced: 2 months ago
JSON representation
GitHub Action for generating a PDF from LaTeX
- Host: GitHub
- URL: https://github.com/hspaans/latexmk-action
- Owner: hspaans
- License: mit
- Created: 2020-08-20T00:02:00.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-04-13T21:23:36.000Z (9 months ago)
- Last Synced: 2024-04-14T12:01:52.079Z (9 months ago)
- Topics: document, github-action, latex, pdf
- Language: TeX
- Homepage:
- Size: 153 KB
- Stars: 6
- Watchers: 2
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# latexmk-action
## Usage
This GitHub Action run latexmk to convert a LaTeX file into a PDF.
## Parameters
Following parameters can be used as `step.with` keys:
| Name | Type | Default | Description |
| ---------- | ------ | ---------- | ------------------------------------ |
| `format` | String | `pdf` | Output format for the LaTeX filename |
| `filename` | String | `main.tex` | Source LaTeX filename to process |
| `options` | String | | Additional options for latexmk |
## Example
Example workflow to generate a PDF document from a LaTeX file:
```yaml
---
name: CI
on: [push]
jobs:
build-test:
runs-on: ubuntu-latest
steps:
- name: Checkout Code
uses: actions/checkout@v2
- name: Generate PDF document
uses: hspaans/[email protected]
with:
format: pdf
filename: article.tex
options: -shell-escape
```
Example workflow to generate a PDF document from a LaTeX file `article.tex` with a configuration file `.latexmkrc`:
```yaml
---
name: CI
on: [push]
jobs:
build-test:
runs-on: ubuntu-latest
steps:
- name: Checkout Code
uses: actions/checkout@v2
- name: Generate PDF document
uses: hspaans/[email protected]
with:
filename: article.tex
```
## Keep up-to-date with GitHub Dependabot
[GitHub Actions has native support](https://docs.github.com/en/github/administering-a-repository/configuration-options-for-dependency-updates#package-ecosystem) for [Dependabot](https://docs.github.com/en/github/administering-a-repository/keeping-your-actions-up-to-date-with-github-dependabot),
to enable it on your GitHub repository all you need to do is add the `.github/dependabot.yml` file:
```yaml
---
version: 2
updates:
- package-ecosystem: github-actions
directory: /
schedule:
interval: daily
```
## Limitation
This action is only available for Linux [virtual environments](https://help.github.com/en/articles/virtual-environments-for-github-actions#supported-virtual-environments-and-hardware-resources).