Skip to content

Commit

Permalink
Merge pull request #221 from dalibo/218_release_21_09
Browse files Browse the repository at this point in the history
Release 22.03
  • Loading branch information
daamien authored Mar 16, 2022
2 parents a9e7205 + 59cc36f commit e86ca17
Show file tree
Hide file tree
Showing 6 changed files with 114 additions and 279 deletions.
13 changes: 11 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,28 @@
Changelog
===============================================================================

21.05 - Work In Progress
22.03
-------------------------------------------------------------------------------

__Stack__

* Debian 10 buster
* Pandoc 2.11
* Pandoc 2.14
* Eisvogel 2.0

__Changes__

<https://github.com/dalibo/pandocker/milestone/12>

* [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
-------------------------------------------------------------------------------
Expand Down
72 changes: 0 additions & 72 deletions INSTALL.md

This file was deleted.

93 changes: 93 additions & 0 deletions NEWS.md
Original file line number Diff line number Diff line change
@@ -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 : <https://github.com/dalibo/pandocker>
* Docker Hub : <https://hub.docker.com/r/dalibo/pandocker/>


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:

<https://github.com/dalibo/pandocker/labels/Junior%20Job>



---

Pandocker 21.02: Major upgrade
================================================================================

Expand Down
11 changes: 10 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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
```

Expand Down
1 change: 0 additions & 1 deletion RELEASING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`
Expand Down
Loading

0 comments on commit e86ca17

Please sign in to comment.