Skip to content

Commit

Permalink
add chktex compatibility and enable in VS Code. Add lint.yml workflow…
Browse files Browse the repository at this point in the history
… for #2. Update name of create-pdf in favor of build-and-deploy
  • Loading branch information
aridyckovsky committed May 5, 2024
1 parent 4e241ea commit 284ef7d
Show file tree
Hide file tree
Showing 6 changed files with 59 additions and 0 deletions.
19 changes: 19 additions & 0 deletions .chktexrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
#####################################################################
#
# Enter which type of quote-style you are using here. Currently, we
# support the following styles:
#
# Style Example of use
# Traditional "An example," he said, "would be great."
# Logical "An example", he said, "would be great".
#

QuoteStyle = Traditional

#####################################################################
#
# Enter here what interval you have between your tabs. Only regular
# intervals are supported.
#

TabSize = 8
File renamed without changes.
21 changes: 21 additions & 0 deletions .github/workflows/lint.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
name: Lint TeX

on:
push:
branches: [ main, drafting ]
pull_request:
branches: [ main, drafting ]
workflow_dispatch:

jobs:
lint:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
with:
ref: ${{ github.head_ref }}
- name: ChkTeX Linter
uses: j2kun/[email protected]
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
1 change: 1 addition & 0 deletions .markdownlintignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
.chktexrc
1 change: 1 addition & 0 deletions .vscode/extensions.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,6 @@
"recommendations": [
"james-yu.latex-workshop",
"tecosaur.latex-utilities",
"davidanson.vscode-markdownlint"
]
}
17 changes: 17 additions & 0 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,22 @@
"editor.tabSize": 2,
"editor.autoIndent": "advanced"
},
"[markdown]": {
"editor.formatOnSave": true,
"editor.formatOnType": false,
"editor.formatOnPaste": false,
"editor.codeActionsOnSave": {
"source.fixAll": true
}
},

//* Markdownlint *//
"markdownlint.lintWorkspaceGlobs": [
// Source: https://github.com/microsoft/vscode/blob/main/extensions/markdown-basics/package.json
"**/*.{md,mkd,mdwn,mdown,markdown,markdn,mdtxt,mdtext,workbook}",
// Additional exclusions
"!**/.git",
],

//* LaTeX Workshop *//
"latex-workshop.intellisense.package.enabled": true,
Expand Down Expand Up @@ -55,6 +71,7 @@
"--output-directory=%OUTDIR%",
"%DOCFILE%"
],
"latex-workshop.linting.chktex.enabled": true,

//* LaTeX Utilities *//
"latex-utilities.countWord.format": "${words} Words (${wordsBody} in Body)",
Expand Down

0 comments on commit 284ef7d

Please sign in to comment.