Code Monkey home page Code Monkey logo

create-latexdiff's Introduction

Action create-latexdiff

A Github action that compares your LaTeX project against an older archived version and creates a "diff" file that highlights the differences. The latexdiff utility is in the core of this action. LaTeX projects are compiled using pdflatex with latexmk. Overleaf's latexmk global configuration is used. The archived project needs to be in a base.zip archive in the root of the project.

Inputs

main-file

  • Type: optional
  • Default value: main.tex
  • Description: the LaTeX source file in the project that needs to be compiled

Example

The code below needs to be palced in a file .github/workflows/make-diff.yml. You need to have a LaTeX source named main.tex and an arcive named base.zip in the root directory of your project. The base.zip archive contains one directory named base, inside of which is an older version of your project to build the diff against. A file named diff.pdf will be created and uploaded as an artifact. The artifact can be downloaded by going to the "Actions" tab on the repository page, selecting the most recent run, and clicking on the "diff-file" link in the Artifacts section.

on: [push]

jobs:
  test_action:
    runs-on: ubuntu-latest
    name: Make diff
    steps:
      - name: Checkout repository
        uses: actions/checkout@v3
      - name: Generate a diff file
        uses: egor-demidov/[email protected]
        with:
          main-file: 'main.tex'
      - name: Upload diff file artifact
        uses: actions/upload-artifact@v4
        with:
          name: diff-file
          path: diff.pdf

create-latexdiff's People

Contributors

egor-demidov avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.