diff --git a/.github/workflows/build-and-deploy-pdf.yml b/.github/workflows/build-and-deploy-pdf.yml index 09cf895..c1bf07d 100644 --- a/.github/workflows/build-and-deploy-pdf.yml +++ b/.github/workflows/build-and-deploy-pdf.yml @@ -16,17 +16,17 @@ jobs: steps: - name: Checkout - uses: actions/checkout@v3 + uses: actions/checkout@v4 with: fetch-depth: 0 - name: Install GitVersion - uses: gittools/actions/gitversion/setup@v0.9.15 + uses: gittools/actions/gitversion/setup@v1.1.1 with: versionSpec: '5.x' - name: Determine Version - uses: gittools/actions/gitversion/execute@v0.9.15 + uses: gittools/actions/gitversion/execute@v1.1.1 - name: Print SemVer run: | @@ -43,7 +43,7 @@ jobs: sed -i "s|Local-0.1.0|$newVersion|" "src/sections/version.tex" - name: Build PDF - uses: xu-cheng/latex-action@v2 + uses: xu-cheng/latex-action@v3 with: root_file: "${{ env.FILE_NAME }}.tex" working_directory: src @@ -53,7 +53,7 @@ jobs: ls -lsa src - name: Upload artifacts - uses: actions/upload-artifact@v3 + uses: actions/upload-artifact@v4 with: name: "${{ env.FILE_NAME }}-${{ env.GitVersion_InformationalVersion }}" path: | @@ -63,7 +63,7 @@ jobs: src/sections - name: Upload artifacts PDF - uses: actions/upload-artifact@v3 + uses: actions/upload-artifact@v4 with: name: "${{ env.FILE_NAME }}-PDF-${{ env.GitVersion_InformationalVersion }}" path: | @@ -87,4 +87,4 @@ jobs: env: USERNAME: "kolosovpetro" EMAIL: "kolosovp94@gmail.com" - MESSAGE: "CICD deploy of PDF document" \ No newline at end of file + MESSAGE: "CICD deploy of ${{ env.FILE_NAME }} PDF document" diff --git a/.github/workflows/build-pdf.yml b/.github/workflows/build-pdf.yml index 89e005f..585daea 100644 --- a/.github/workflows/build-pdf.yml +++ b/.github/workflows/build-pdf.yml @@ -23,17 +23,17 @@ jobs: steps: - name: Checkout - uses: actions/checkout@v3 + uses: actions/checkout@v4 with: fetch-depth: 0 - name: Install GitVersion - uses: gittools/actions/gitversion/setup@v0.9.15 + uses: gittools/actions/gitversion/setup@v1.1.1 with: versionSpec: '5.x' - name: Determine Version - uses: gittools/actions/gitversion/execute@v0.9.15 + uses: gittools/actions/gitversion/execute@v1.1.1 - name: Print SemVer run: | @@ -50,7 +50,7 @@ jobs: sed -i "s|Local-0.1.0|$newVersion|" "src/sections/version.tex" - name: Build PDF - uses: xu-cheng/latex-action@v2 + uses: xu-cheng/latex-action@v3 with: root_file: "${{ env.FILE_NAME }}.tex" working_directory: src @@ -60,7 +60,7 @@ jobs: ls -lsa src - name: Upload artifacts - uses: actions/upload-artifact@v3 + uses: actions/upload-artifact@v4 with: name: "${{ env.FILE_NAME }}-${{ env.GitVersion_InformationalVersion }}" path: | @@ -70,8 +70,8 @@ jobs: src/sections - name: Upload artifacts PDF - uses: actions/upload-artifact@v3 + uses: actions/upload-artifact@v4 with: name: "${{ env.FILE_NAME }}-PDF-${{ env.GitVersion_InformationalVersion }}" path: | - src/${{ env.FILE_NAME }}.pdf \ No newline at end of file + src/${{ env.FILE_NAME }}.pdf diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..81cbfae --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,17 @@ +# Changelog +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), +and this project adheres to [Semantic Versioning v2.0.0](https://semver.org/spec/v2.0.0.html). + +## [1.1.8] - 2024-07-03 +### Changed +- Changelog added +- README updated +- Theorem environments update +- Footnote added +- Bump GitHub Actions version + +## [1.1.7] - 2024-01-31 +### Changed +- Initial release before change log introduced. diff --git a/README.md b/README.md index eea0077..0ca8385 100644 --- a/README.md +++ b/README.md @@ -12,15 +12,16 @@ LaTeX template for GitHub including general CI/CD actions and Mathematica templa - Install `MikTeX`: https://miktex.org/download - Update `MikTeX` - Install `SumatraPDF` viewer: https://www.sumatrapdfreader.org/download-free-pdf-viewer +- Path to SumatraPDF: `C:\Program Files\SumatraPDF` - Install `Intellij IDEA Ultimate`: https://www.jetbrains.com/idea/download/#section=windows - Activate `Intellij IDEA Ultimate` - Install `TeXiFy IDEA` plugin: https://plugins.jetbrains.com/plugin/9473-texify-idea - Clone this repository locally: `https://github.com/kolosovpetro/github-latex-template.git` - Open `github-latex-template` folder in `Intellij IDEA Ultimate` and configure as follows - LaTeX Configuration - ![LaTeX Configuration](img/latex_configuration.PNG?raw=true "LaTeX Configuration") + ![LaTeX Configuration](./img/latex_configuration.PNG "LaTeX Configuration") - BibTeX Configuration - ![BibTeX Configuration](img/bibtex_configuration.PNG?raw=true "BibTeX Configuration") + ![BibTeX Configuration](./img/bibtex_configuration.PNG "BibTeX Configuration") - Configure Inverse Search in `Intellij IDEA` for SumatraPDF: `Tools -> LaTeX -> Configure Inverse Search` - Compile document using `Shift + F10` diff --git a/out/GithubLatexTemplate.pdf b/out/GithubLatexTemplate.pdf index c91c341..400a6df 100644 Binary files a/out/GithubLatexTemplate.pdf and b/out/GithubLatexTemplate.pdf differ diff --git a/src/GithubLatexTemplate.tex b/src/GithubLatexTemplate.tex index 6f4d5b9..c4c880c 100644 --- a/src/GithubLatexTemplate.tex +++ b/src/GithubLatexTemplate.tex @@ -52,13 +52,38 @@ \def\rrfloor{\right\rfloor\kern-3.5pt\right\rfloor} \newcommand \llceilCoefficient [3] {\llceil \nobarfrac{#1}{#2} \rrfloor_{#3}} +% rascal numbers etc +\newcommand \rascalNumber [3] {\binom{#1}{#2}_{#3}} +\newcommand \north[0] {\mathbf{North}} +\newcommand \south[0] {\mathbf{South}} +\newcommand \west[0] {\mathbf{West}} +\newcommand \east[0] {\mathbf{East}} -\newtheorem{thm}{Theorem}[section] -\newtheorem{cor}[thm]{Corollary} -\newtheorem{lem}[thm]{Lemma} -\newtheorem{examp}[thm]{Example} -\newtheorem{conj}[thm]{Conjecture} -\newtheorem{defn}[thm]{Definition} +% 1-q pascal notation + +\newcommand{\genstirlingI}[3]{% + \genfrac{[}{]}{0pt}{#1}{#2}{#3}% +} +\newcommand{\genstirlingII}[3]{% + \genfrac{\{}{\}}{0pt}{#1}{#2}{#3}% +} +\newcommand{\oneQBinomial}[3]{\genstirlingI{}{#1}{#2}^{#3}} + +% free foot note +\let\svthefootnote\thefootnote +\newcommand\freefootnote[1]{% + \let\thefootnote\relax% + \footnotetext{#1}% + \let\thefootnote\svthefootnote% +} + + +\newtheorem{theorem}{Theorem}[section] +\newtheorem{corollary}[theorem]{Corollary} +\newtheorem{lemma}[theorem]{Lemma} +\newtheorem{example}[theorem]{Example} +\newtheorem{conjecture}[theorem]{Conjecture} +\newtheorem{definition}[theorem]{Definition} \numberwithin{equation}{section} @@ -92,6 +117,7 @@ \tableofcontents + \freefootnote{Sources: \url{https://github.com/kolosovpetro/github-latex-template}} \section{Introduction} \label{sec:introduction} \input{sections/02_introduction}