Skip to content

Commit

Permalink
Updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
Adrian Kosmaczewski committed Mar 28, 2023
1 parent d05c8c2 commit be61679
Show file tree
Hide file tree
Showing 4 changed files with 6 additions and 8 deletions.
File renamed without changes.
2 changes: 1 addition & 1 deletion Dockerfile
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
FROM asciidoctor/docker-asciidoctor:1.41.0
FROM docker.io/asciidoctor/docker-asciidoctor:1.41.0

COPY theme /theme
COPY fonts /theme/fonts
Expand Down
4 changes: 2 additions & 2 deletions Makefile
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
all: image

image:
docker build -t vshn/asciidoctor-epub3:1.14.2 .
podman build -t ghcr.io/vshn/asciidoctor-epub3:master .

build/test.epub:
docker run --rm --tty --user "$$(id -u)" --volume "$${PWD}":/documents vshn/asciidoctor-epub3:1.14.2 sample/test.adoc --destination-dir=build
podman run --rm --volume "$${PWD}":/documents ghcr.io/vshn/asciidoctor-epub3:master sample/test.adoc --destination-dir=build

clean:
rm -rf build
8 changes: 3 additions & 5 deletions README.adoc
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
= VSHN EPUB3 Generator based on Asciidoctor

This project generates a Docker image to be used to generate EPUB3 books with a standard VSHN style and fonts.

The image is available in https://hub.docker.com/r/vshn/asciidoctor-epub3[Docker Hub].
This project generates a container image to be used to generate EPUB3 books with a standard VSHN style and fonts.

== Build

Expand All @@ -12,11 +10,11 @@ Run the `make` command to build the image.

Run the following command to build an EPUB3 using an Asciidoc file as a basis:

`docker run --rm --tty --user "$(id -u)" --volume "${PWD}":/documents vshn/asciidoctor-epub3:1.14.1 file.adoc`
`podman run --rm --volume "${PWD}":/documents ghcr.io/vshn/asciidoctor-epub3:1.14.1 file.adoc`

Any parameters passed after the command line will be fed directly to Asciidoctor, for example

`docker run --rm --tty --user "$(id -u)" --volume "${PWD}":/documents vshn/asciidoctor-epub3:1.14.1 file.adoc --destination-dir=./_archive`
`podman run --rm --volume "${PWD}":/documents ghcr.io/vshn/asciidoctor-epub3:1.14.1 file.adoc --destination-dir=./_archive`

== Default Attributes

Expand Down

0 comments on commit be61679

Please sign in to comment.