feat: update pandoc 3.1 and bump to v1.0.0 (#35)

* fix(pandoc.yml): Update pandoc and pandoc-crossref
* GitHub action artefacts added
* fix(thesis): typos and cross-ref fixed
* fix: rerun `make all` with pandoc 3.1.2
* fix: enhanced docs
* ci: Changelog improved
* docs: Changelog updated

.github/workflows/changelog.yaml

@@ -12,7 +12,7 @@ jobs:
         with:
           fetch-depth: 0
       - name: Generate a changelog
-        uses: orhun/git-cliff-action@v1
+        uses: orhun/git-cliff-action@v2
         id: git-cliff
         with:
           config: cliff.toml

.github/workflows/pandoc.yml

@@ -9,10 +9,10 @@ jobs:
       - uses: actions/checkout@v3
       - name: install pandoc and pandoc-crossref
         run: |
-          wget https://github.com/jgm/pandoc/releases/download/3.0.1/pandoc-3.0.1-1-amd64.deb
-          sudo dpkg -i pandoc-3.0.1-1-amd64.deb
-          rm pandoc-3.0.1-1-amd64.deb
-          wget https://github.com/lierdakil/pandoc-crossref/releases/download/v0.3.15.0/pandoc-crossref-Linux.tar.xz
+          wget https://github.com/jgm/pandoc/releases/download/3.1.2/pandoc-3.1.2-1-amd64.deb
+          sudo dpkg -i pandoc-3.1.2-1-amd64.deb
+          rm pandoc-3.1.2-1-amd64.deb
+          wget https://github.com/lierdakil/pandoc-crossref/releases/download/v0.3.15.2a/pandoc-crossref-Linux.tar.xz
           tar -xvf pandoc-crossref-Linux.tar.xz
           sudo mv pandoc-crossref /usr/bin
       - uses: actions/cache@v3

.gitignore

@@ -1,6 +1,4 @@
-pandoc-2.19.2-1-amd64.deb
-pandoc-crossref-Linux.tar.xz
-pandoc-crossref.1
+pandoc-*
 
 # Created by https://www.toptal.com/developers/gitignore/api/git,linux,macos,dotenv,windows,visualstudiocode,node
 # Edit at https://www.toptal.com/developers/gitignore?templates=git,linux,macos,dotenv,windows,visualstudiocode,node

CHANGELOG.md

@@ -7,6 +7,18 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased](https://github.com/maehr/academic-pandoc-template/compare/...HEAD)
 
+## [1.0.0](https://github.com/maehr/academic-pandoc-template/tree/v1.0.0) - 2023-04-11
+
+### Fixed
+
+- Pandoc updated to 3.1.2 and pandoc-crossref to 0.3.15.2a
+- Rerun `make all` with pandoc 3.1.2
+- Enhanced docs
+
+### Ci
+
+- Changelog improved
+
 ## [1.0.0-beta](https://github.com/maehr/academic-pandoc-template/tree/v1.0.0-beta) - 2023-02-03
 
 ### Fixed

README.md

@@ -9,8 +9,8 @@
 [![DOI](https://zenodo.org/badge/139726344.svg)](https://zenodo.org/badge/latestdoi/139726344)
 
 <!-- prettier-ignore -->
-| from md | [article/article.md](article/article.md)[article/article.md](article/article.md) | [presentation/presentation.md](presentation/presentation.md) | [thesis/00.md](thesis/00.md) |
-|---|-----|-----|-----|
+| from md | [article](article/article.md) | [presentation](presentation/presentation.md) | [thesis](thesis/00.md) |
+| :--- | :-----: | :-----: | :-----: |
 | | [![](assets/images/article.png)](article/article.md) | [![](assets/images/presentation.png)](presentation/presentation.md) | [![](assets/images/thesis.png)](thesis/00.md) |
 | to html | | [![](assets/images/presentation-html.png)](presentation/presentation.html) | |
 | to docx | [![](assets/images/article-docx.png)](article/article.docx) | | [![](assets/images/thesis-docx.png)](thesis/thesis.pdf) |
@@ -30,6 +30,9 @@ Follow the [The Markdown Guide](https://www.markdownguide.org/) and make sure yo
 3. Edit [article/references.bib](article/references.bib), [presentation/references.bib](presentation/references.bib) or [thesis/references.bib](thesis/references.bib) [online](https://docs.github.com/en/github/managing-files-in-a-repository/managing-files-on-github/editing-files-in-your-repository), with [JabRef](http://www.jabref.org/) or with your favorite Bibtex editor
 4. [Commit](https://docs.github.com/en/desktop/contributing-and-collaborating-using-github-desktop/making-changes-in-a-branch/committing-and-reviewing-changes-to-your-project) your changes
 5. Manually run the [Pandoc GitHub actions](https://github.com/maehr/academic-pandoc-template/actions/workflows/pandoc.yml) to build your document. They will be commited to main branch as well. [![](assets/images/workflow_dispatch.png)](https://github.com/maehr/academic-pandoc-template/actions/workflows/pandoc.yml)
+   a. Click on [Actions](https://github.com/maehr/academic-pandoc-template/actions) in the top menu
+   b. Click on [Pandoc](https://github.com/maehr/academic-pandoc-template/actions/workflows/pandoc.yml) in the left menu
+   c. Click on `Run workflow` in the top right corner
 
 ### Use it locally
 

article/article.tex

@@ -97,7 +97,12 @@
 \makeatletter
 \def\fps@figure{htbp}
 \makeatother
-\usepackage{soul}
+\ifLuaTeX
+  \usepackage{luacolor}
+  \usepackage[soul]{lua-ul}
+\else
+  \usepackage{soul}
+\fi
 \setlength{\emergencystretch}{3em} % prevent overfull lines
 \providecommand{\tightlist}{%
   \setlength{\itemsep}{0pt}\setlength{\parskip}{0pt}}

package.json

@@ -1,15 +1,17 @@
 {
 	"name": "academic-pandoc-template",
-	"version": "0.0.8",
+	"version": "1.0.0",
 	"scripts": {
 		"check": "prettier --ignore-path .gitignore  --check . '!{CODE_OF_CONDUCT.md,LICENSE.md,_layouts/default.html}'",
 		"commit": "cz",
 		"format": "prettier --ignore-path .gitignore --write . '!{CODE_OF_CONDUCT.md,LICENSE.md,_layouts/default.html}'",
-		"prepare": "husky install"
+		"prepare": "husky install",
+		"changelog": "git-cliff --config .git-cliff.toml"
 	},
 	"devDependencies": {
-		"commitizen": "^4.2.5",
+		"commitizen": "^4.3.0",
 		"cz-conventional-changelog": "^3.3.0",
+		"git-cliff": "^1.1.2",
 		"husky": "^7.0.4",
 		"prettier": "~2.2.1"
 	},