https://github.com/j2kun/chktex-action

A Github action to lint a LaTeX file for style and formatting issues.
https://github.com/j2kun/chktex-action

Last synced: 4 days ago
JSON representation

A Github action to lint a LaTeX file for style and formatting issues.

• Host: GitHub
• URL: https://github.com/j2kun/chktex-action
• Owner: j2kun
• Created: 2019-09-02T04:35:29.000Z (about 5 years ago)
• Default Branch: main
• Last Pushed: 2024-04-12T20:39:47.000Z (7 months ago)
• Last Synced: 2024-04-14T04:57:01.146Z (7 months ago)
• Language: Python
• Size: 44.9 KB
• Stars: 16
• Watchers: 3
• Forks: 8
• Open Issues: 2
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Lint your LaTeX files with chktex

[chktex](https://www.nongnu.org/chktex/) is a LaTeX linter. A _linter_ is a

program that checks your work for stylistic errors. In the case of LaTeX, style

errors include soft tex-O's (which don't generate errors) and decisions that

result in rendering irregularities.

This action runs chktex on all `.tex` files in your repository.

To configure the linter, add a `.chktexrc` file to your repository. An example

is provided in this repo.

Example configuration: https://gist.github.com/j2kun/aa4a768150d423f581b758103b2b020c

```

# in .github/workflows/lint.yml

name: Lint

on: 

  push:

    branches:

      - main

  pull_request:

    branches:

      - main

jobs:

  build:

    runs-on: ubuntu-latest

    steps:

    - uses: actions/checkout@v1

    - name: LaTeX linter (chktex)

      uses: j2kun/chktex-action@main

      env:

        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

```