https://github.com/kitforbes/docker-epubcheck
Dockerfile for EPUBCheck
https://github.com/kitforbes/docker-epubcheck
container-image docker-image dockerfile epubcheck
Last synced: 11 months ago
JSON representation
Dockerfile for EPUBCheck
- Host: GitHub
- URL: https://github.com/kitforbes/docker-epubcheck
- Owner: kitforbes
- Created: 2019-08-05T20:03:14.000Z (over 6 years ago)
- Default Branch: main
- Last Pushed: 2023-10-24T12:33:44.000Z (over 2 years ago)
- Last Synced: 2025-01-16T11:58:54.067Z (about 1 year ago)
- Topics: container-image, docker-image, dockerfile, epubcheck
- Language: CSS
- Homepage: https://hub.docker.com/r/kitforbes/epubcheck
- Size: 45.9 KB
- Stars: 2
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# docker-epubcheck
Dockerfile for [EPUBCheck](https://github.com/w3c/epubcheck), available on [Docker Hub](https://hub.docker.com/r/kitforbes/epubcheck).
## Build
Run the PowerShell script:
```powershell
.\build.ps1 -Version "5.1.0"
```
Or run directly with:
```bash
docker build --build-arg "EPUBCHECK_VERSION=5.1.0" --tag "epubcheck:5.1.0" .
```
## Usage
### Version (Default)
Displays the version of EPUBCheck.
```bash
docker run --rm --name epubcheck "epubcheck:5.1.0"
```
```plaintext
EPUBCheck v5.1.0
Messages: 0 fatals / 0 errors / 0 warnings / 0 infos
EPUBCheck completed
```
### Help
Displays help information for EPUBCheck.
```bash
docker run --rm --name epubcheck "epubcheck:5.1.0" --help
```
```plaintext
EPUBCheck v5.1.0
When running this tool, the first argument should be the name (with the path)
of the file to check.
To specify a validation profile (to run checks against a specific EPUB 3 profile
or extension specification), use the -profile option:
Validation profiles supported:
--profile default = the default validation profile
--profile dict = validates against the EPUB Dictionaries and Glossaries specification
--profile edupub = validates against the EDUPUB Profile
--profile idx = validates against the EPUB Indexes specification
--profile preview = validates against the EPUB Previews specification
If checking a non-epub file, the epub version of the file must
be specified using -v and the type of the file using -mode.
The default version is: 3.0.
Modes and versions supported:
--mode opf -v 2.0
--mode opf -v 3.0
--mode xhtml -v 2.0
--mode xhtml -v 3.0
--mode svg -v 2.0
--mode svg -v 3.0
--mode nav -v 3.0
--mode mo -v 3.0 = for Media Overlays validation
--mode exp = for expanded EPUB archives
This tool also accepts the following options:
--save = saves the epub created from the expanded epub
--out = output an assessment XML document file (use - to output to console)
--xmp = output an assessment XMP document file (use - to output to console)
--json = output an assessment JSON document file (use - to output to console)
-m = same as --mode
-p = same as --profile
-o = same as --out
-x = same as --xmp
-j = same as --json
--failonwarnings[+|-] = By default, the tool returns a 1 if errors are found in the file or 0 if no errors
are found. Using --failonwarnings will cause the process to exit with a status of
1 if either warnings or errors are present and 0 only when there are no errors or warnings.
-q, --quiet = no message on console, except errors, only in the output
-f, --fatal = include only fatal errors in the output
-e, --error = include only error and fatal severity messages in ouput
-w, --warn = include fatal, error, and warn severity messages in output
-u, --usage = include ePub feature usage information in output
(default is OFF); if enabled, usage information will
always be included in the output file
--locale = output localized messages according to the provided IETF BCP 47 language tag string.
-l, --listChecks [] = list message ids and severity levels to the custom message file named
or the console
-c, --customMessages [] = override message severity levels as defined in the custom message file named
--version = displays the EPUBCheck version
-h, -? or --help = displays this help message
Messages: 0 fatals / 0 errors / 0 warnings / 0 infos
EPUBCheck completed
```