From c11ab0728a11f26cdaf12ed325fe9405131e7241 Mon Sep 17 00:00:00 2001 From: damien clochard Date: Wed, 11 Aug 2021 17:56:06 +0200 Subject: [PATCH 1/3] Release 21.09 --- CHANGELOG.md | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 4087575..594aad3 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,19 +1,28 @@ Changelog =============================================================================== -21.05 - Work In Progress +21.09 ------------------------------------------------------------------------------- __Stack__ * Debian 10 buster -* Pandoc 2.11 +* Pandoc 2.14 * Eisvogel 2.0 __Changes__ +* [extra] Upgrade to pandoc 2.14 +* [filters] Upgrade pandoc-latex-admonition +* [CI] check for pandoc-crossref version mismatch +* [extra] embed revealjs 4.1.2 for offline builds +* [extra] add awesomebox + fontawesome +* [extra] Adds librsvg to alpine and buster containers (@colindean) +* [filters] Bump pygments from 2.4 to 2.7.4 +* [extra] Add support for Spanish (@iapellaniz) + 21.02 ------------------------------------------------------------------------------- From 13681d0073d566018284efd3c01998579352eb9f Mon Sep 17 00:00:00 2001 From: damien clochard Date: Wed, 11 Aug 2021 18:05:52 +0200 Subject: [PATCH 2/3] fixup cleanup --- INSTALL.md | 72 ------------------ README.md | 12 ++- RELEASING.md | 1 - UPGRADE.md | 203 --------------------------------------------------- 4 files changed, 11 insertions(+), 277 deletions(-) delete mode 100644 INSTALL.md delete mode 100644 UPGRADE.md diff --git a/INSTALL.md b/INSTALL.md deleted file mode 100644 index 2074594..0000000 --- a/INSTALL.md +++ /dev/null @@ -1,72 +0,0 @@ -# Install the Pandocker toolchain - -> WARNING: This page is not maintained anymore and we are planning to remove -> it in further versions. Please open an issue if this was useful to you. - -² -## With docker - -``` -docker pull dalibo/pandocker:stable -``` - -## Without docker (local setup) - -__TL;DR:__ The entire toolchain is a very _long_ and _precise_ list of -dependencies : debian, latex, pandoc, etc. All versions are set in stone. -You can probably make it work `Fedora` or `Arch` but you will be in uncharted -territory. We will only provide support for this specific setup. - -Also we follow a very fast release cycle and deliver a new stable version every -3 months. This means that if you choose to install the toolchain locally, you -will need to [upgrade](UPGRADE.md) manually your setup on a regular basis. - -**In a nutshell** : If you want to make your life easier, use the docker image -as described above. - - -### 1. Environment - -Install Debian Stretch - -### 2. Pandoc - -```shell -URL=https://github.com/jgm/pandoc/releases/download/2.7/pandoc-2.7-1-amd64.deb -wget -O pandoc.deb $URL -dpkg --install pandoc.deb -``` - - -### 3. The latex packages - -Here be dragons ! Prepare yourself for 1 GB of obscure latex dependencies. - -```shell -sudo apt install lmodern texlive texlive-lang-french texlive-lang-german \ - texlive-luatex texlive-pstricks texlive-xetex \ - fonts-lato fonts-liberation -``` - - - -### 4. Pandoc filters - -We're using `python3` and `pip` to fetch the filters. The list of Python -packages can be found in the [requirements.txt](requirements.txt) file. - -```shell -sudo apt install python3-pip python3-setuptools python3-wheel python3-yaml -sudo pip3 install -r requirements.txt -``` - -The `sudo` prefix is important ! - -### 5. Misc. - -Some tools for post-production : - -```shell -sudo apt install openssh-client rsync poppler-utils zlibc make \ - git parallel wget -``` diff --git a/README.md b/README.md index 1a2ddf8..25c994f 100644 --- a/README.md +++ b/README.md @@ -14,6 +14,15 @@ A simple docker image for pandoc with [filters], [templates], [fonts] and [addit [fonts]: #fonts [additional tools]: #additional_tools +## Install / Upgrade + +Download the image with: + +```console +docker pull dalibo/pandocker:stable +``` + +Whenever a new stable version is released, launch that command again to refresh your image. ## How To @@ -43,7 +52,7 @@ $ docker run --rm -u `id -u`:`id -g` -v `pwd`:/pandoc dalibo/pandocker README.md > Add this to your `~/.bashrc` : ```console -$ alias pandoc="docker run --rm -u `id -u`:`id -g` -v `pwd`:/pandoc dalibo/pandocker" +$ alias pandoc="docker run --rm -u `id -u`:`id -g` -v `pwd`:/pandoc dalibo/pandocker:stable" $ pandoc README.md -o README.epub ``` @@ -121,6 +130,7 @@ The pandocker image includes the following open-source fonts: * Deja Vu: https://dejavu-fonts.github.io/ * Lato: https://fonts.google.com/specimen/Lato * Liberation: https://github.com/liberationfonts/liberation-fonts +* Fontawesome: https://fontawesome.com/ The full variant includes diff --git a/RELEASING.md b/RELEASING.md index 64e8cf0..6179616 100644 --- a/RELEASING.md +++ b/RELEASING.md @@ -3,7 +3,6 @@ * [ ] Close all open ticket on the current milestone * [ ] Create a `release` branch * [ ] Update the [CHANGELOG.md]() -* [ ] Update the [UPGRADE.md]() procedure * [ ] Write a announcement in [NEWS.md]() * [ ] Merge the `release` branch into `latest` * [ ] Add a tag to `latest` diff --git a/UPGRADE.md b/UPGRADE.md deleted file mode 100644 index c279711..0000000 --- a/UPGRADE.md +++ /dev/null @@ -1,203 +0,0 @@ -# Upgrade the Pandocker toolchain - -> WARNING: This page is not maintained anymore and we are planning to remove -> it in further versions. Please open an issue if this was useful to you. - - -## With docker - -``` -docker pull dalibo/pandocker:stable -``` - -## Without docker (local setup) - -__TL;DR:__ We're releasing a stable version of the toolchain every 3 months and -we will only support the latest stable version. If you want to make your life -easier, use the docker image as described above. - - -## Upgrade from 19.11 to 20.02 - -1. Upgrade Pandoc - -```shell -make warm-cache -sudo dpkg --install cache/pandoc.deb -``` - -2. Install pandoc-crossref - -```shell -make warm-cache -tar xf ./cache/pandoc-crossref.tar.gz -install pandoc-crossref /usr/local/bin/ -``` - -3. Upgrade Eisvogel - -```shell -$ export EISVOGEL_REPO=https://raw.githubusercontent.com/Wandmalfarbe/pandoc-latex-template -$ export EISVOGEL_VERSION=v1.4.0 -$ export TEMPLATES_DIR=~/.pandoc/templates -$ wget ${EISVOGEL_REPO}/${EISVOGEL_VERSION}/eisvogel.tex -O ${TEMPLATES_DIR}/eisvogel.latex -``` - - - -## Upgrade from 19.08 to 19.11 - -1. Upgrade Pandoc - -```shell -URL=https://github.com/jgm/pandoc/releases/download/2.7/pandoc-2.7-3-amd64.deb -wget -O pandoc.deb $URL -sudo dpkg --install pandoc.deb -``` - -2. Upgrade Eisvogel - -```shell -$ export EISVOGEL_REPO=https://raw.githubusercontent.com/Wandmalfarbe/pandoc-latex-template -$ export EISVOGEL_VERSION=v1.3.0 -$ export TEMPLATES_DIR=~/.pandoc/templates -$ wget ${EISVOGEL_REPO}/${EISVOGEL_VERSION}/eisvogel.tex -O ${TEMPLATES_DIR}/eisvogel.latex -``` - -### Upgrade from 19.05 to 19.08 - - -1. Install the codeblock-include filter - -```shell -pip3 install --upgrade -r requirements.txt -``` - - -### Upgrade from 19.02 to 19.05 - -1. Upgrade Pandoc - -```shell -URL=https://github.com/jgm/pandoc/releases/download/2.7/pandoc-2.7-1-amd64.deb -wget -O pandoc.deb $URL -sudo dpkg --install pandoc.deb -``` - -2. Install the include filter - -```shell -pip3 install --upgrade -r requirements.txt -``` - - -### Upgrade from 18.11 to 19.02 - -1. Upgrade Pandoc 2 - -```shell -URL=https://github.com/jgm/pandoc/releases/download/2.6/pandoc-2.6-1-amd64.deb -wget -O pandoc.deb $URL -sudo dpkg --install pandoc.deb -``` - -2. Install python-mustache and upgrade other packages - -```shell -pip3 install --upgrade -r requirements.txt -``` - -### Upgrade from 18.08 to 18.11 - -1. Upgrade Pandoc 2 - -```shell -URL=https://github.com/jgm/pandoc/releases/download/2.1.3/pandoc-2.1.3-1-amd64.deb -wget -O pandoc.deb $URL -sudo dpkg --install pandoc.deb -``` - -2. Install the eisvogel template - -```shell -URL=https://raw.githubusercontent.com/Wandmalfarbe/pandoc-latex-template/master/eisvogel.tex -TEMPLATES_DIR=~/.pandoc/templates -wget $URL -O ${TEMPLATES_DIR}/eisvogel.latex -tlmgr init-usertree -tlmgr install ly1 inconsolata sourcesanspro sourcecodepro mweights -``` - -### Upgrade from 18.06 to 18.08 - -```shell -sudo apt install fonts-liberation -``` - - -### Upgrade from 18.03 to 18.06 - - -```shell -sudo apt install texlive-lang-german -``` - -### Upgrade from 17.12 to 18.03 - - -1. Upgrade to Pandoc 2: - -```shell -URL=https://github.com/jgm/pandoc/releases/download/2.1.3/pandoc-2.1.3-1-amd64.deb -wget -O pandoc.deb $URL -sudo dpkg --install pandoc.deb -``` - -2. Add more latex packages - - -```shell -sudo apt install texlive-luatex texlive-pstricks -``` - -3. Upgrade the filters - -```shell -sudo pip3 install --upgrade -r requirements.txt -``` - ---- - -### Upgrade from 17.09 to 17.12 - -Upgrade is not possible :-( - -You need to install a brand new `Debian Stretch` system and replay the entire -[install](INSTALL.md) process. - ---- - -### Upgrade from 17.06 to 17.09 - -You need to add the levelup filter - -```shell -sudo pip3 install pandoc-latex-levelup -``` - ---- - -### Upgrade from 17.03 to 17.06 - - -The panflute module requires `python3` - -```shell -sudo apt-get install python3 python3-dev python3-pip python3-virtualenv -sudo pip3 install panflute -``` - -The post-production script requires pypdf2 - -```shell -pip install pypdf2 -``` From 59cc36f15baa63eb4de9f84f9ed605c51ee8d91a Mon Sep 17 00:00:00 2001 From: damien clochard Date: Wed, 16 Mar 2022 17:00:40 +0100 Subject: [PATCH 3/3] bump to 22.03 --- CHANGELOG.md | 2 +- NEWS.md | 93 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 94 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 594aad3..c3ca236 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,7 +1,7 @@ Changelog =============================================================================== -21.09 +22.03 ------------------------------------------------------------------------------- __Stack__ diff --git a/NEWS.md b/NEWS.md index 857d9bb..611b7c4 100644 --- a/NEWS.md +++ b/NEWS.md @@ -1,4 +1,97 @@ +Pandocker 22.03: awesomebox + fontawesome +================================================================================ + +Paris, March 16th, 2022 + + +What is this ? +-------------------------------------------------------------------------------- + +Pandocker is a docker image containing a complete document production toolchain +based on `pandoc` with filters, templates, fonts, and the latex bazaar + +It allows you to generate slides and documents without installing the required +depencies on your machine. It is also very usefull to integrate pandoc into +a CI workflow such as Github Actions, Gitlab Pipelines, etc. + +For instance to generate an EPUB file from a markdown source, you can simply +type: + +``` +docker run --rm -v `pwd`:/pandoc dalibo/pandocker test.md -o test.epub +``` + +This image is available under BSD Licence and it has 4 main tags: + +* `stable` should be used in production +* `stable-full` for non-european languages +* `latest` and `latest-full` are the development versions + +You can also retrieve older versions by their version number: +`dalibo/pandocker:19.11`, `dalibo/pandocker:21.02-full`, etc. + +For more details : + +* Github : +* Docker Hub : + + +awesomebox + fontawesome +-------------------------------------------------------------------------------- + +This new version brings a new package called `awesomebox`. Along with the +`fontawesome` font and the `pandoc-latex-environment` filter, it allows users +to add "boxes" in the pdf documents. + +Here's a basic example + +```markdown +--- +header-includes: +- | + ```{=latex} + \usepackage{awesomebox} + ``` +pandoc-latex-environment: + warningblock: [warning] +... + +# Boxes with awesomebox + +This is a normal paragraph. + +::: warning +ATTENTION: This is a warning box ! +::: + +``` +You can see the result below: + +https://github.com/Wandmalfarbe/pandoc-latex-template/blob/master/examples/boxes-with-pandoc-latex-environment-and-awesomebox/document.pdf + + +How to upgrade +-------------------------------------------------------------------------------- + +```console +docker pull dalibo/pandocker:stable +``` + + +How to contribute +-------------------------------------------------------------------------------- + +Pandocker is an open project, contributions are welcome. + +If you want to help, you can find a list of "Junior Jobs" here: + + + + + +--- + Pandocker 21.02: Major upgrade ================================================================================