From 8d5de21c9def02b443a2ae1e20031b2bca2b3b66 Mon Sep 17 00:00:00 2001 From: Colin Leong <--unset> Date: Thu, 20 Jun 2024 12:54:19 -0400 Subject: [PATCH 1/3] CDL: add notes/docs about pandoc version requirement --- Makefile | 4 ++++ README.md | 2 +- 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/Makefile b/Makefile index 96930d4..8e2773e 100644 --- a/Makefile +++ b/Makefile @@ -2,6 +2,10 @@ markdown: dst dst/index.html dst/style.css server: dst dst/style.css dst/index.md dst/sitemap.xml +# CDL: this is where the bibliography @ citations are transformed, I believe, to things like (Someone 2024) +# also, requires a newer version of pandoc, in order to use --citeproc +# https://pandoc.org/releases.html#pandoc-2.11-2020-10-11 or greater, +# which means that on Ubuntu you may need to go directly to the source repo and download/install the .deb dst/index.html: dst/index.md src/references.bib src/template/index.html dst/style.css pandoc dst/index.md --template src/template/index.html -s --table-of-contents --bibliography=src/references.bib --citeproc --columns 1000 -H src/header.html -V lang=en -o $@ diff --git a/README.md b/README.md index cbea270..3db737f 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@ The hosted github page is automatically built on push to master. To build the page locally, run `make`. -Make sure you have [pandoc](https://pandoc.org/) installed. +Make sure you have [pandoc](https://pandoc.org/) installed, version 2.11 or greater. ## Development To continuously build the page locally, listening to changes, run: From 561888027f183bcd6355eb33aefe9c88421ce617 Mon Sep 17 00:00:00 2001 From: Colin Leong <122366389+cleong110@users.noreply.github.com> Date: Thu, 20 Jun 2024 13:51:06 -0400 Subject: [PATCH 2/3] CDL: type->which in bash script to check if program exists --- src/markdown_fix.sh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/markdown_fix.sh b/src/markdown_fix.sh index cdd7163..26266d8 100644 --- a/src/markdown_fix.sh +++ b/src/markdown_fix.sh @@ -1,6 +1,6 @@ #!/bin/bash -if type gsed >/dev/null +if which gsed >/dev/null then echo "Using gsed" function ssed { gsed "$@" ;} From 4fd0638085b1241477bb587396e042ce78798889 Mon Sep 17 00:00:00 2001 From: Colin Leong <122366389+cleong110@users.noreply.github.com> Date: Thu, 20 Jun 2024 13:58:45 -0400 Subject: [PATCH 3/3] CDL: add a clearer troubleshooting note --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 3db737f..9b37bc7 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,8 @@ The hosted github page is automatically built on push to master. To build the page locally, run `make`. -Make sure you have [pandoc](https://pandoc.org/) installed, version 2.11 or greater. +Make sure you have [pandoc](https://pandoc.org/) installed. +If you see "unknown option: --citeproc", you may need to install [the latest version directly](https://github.com/jgm/pandoc/releases/latest) rather than with `apt`. ## Development To continuously build the page locally, listening to changes, run: