https://github.com/w3c/epubcheck Skip to content Navigation Menu Toggle navigation Sign in * Product + Actions Automate any workflow + Packages Host and manage packages + Security Find and fix vulnerabilities + Codespaces Instant dev environments + GitHub Copilot Write better code with AI + Code review Manage code changes + Issues Plan and track work + Discussions Collaborate outside of code Explore + All features + Documentation + GitHub Skills + Blog * Solutions By size + Enterprise + Teams + Startups By industry + Healthcare + Financial services + Manufacturing By use case + CI/CD & Automation + DevOps + DevSecOps * Resources Topics + AI + DevOps + Security + Software Development + View all Explore + Learning Pathways + White papers, Ebooks, Webinars + Customer Stories + Partners * Open Source + GitHub Sponsors Fund open source developers + The ReadME Project GitHub community articles Repositories + Topics + Trending + Collections * Enterprise + Enterprise platform AI-powered developer platform Available add-ons + Advanced Security Enterprise-grade security features + GitHub Copilot Enterprise-grade AI features + Premium Support Enterprise-grade 24/7 support * Pricing Search or jump to... Search code, repositories, users, issues, pull requests... Search [ ] Clear Search syntax tips Provide feedback We read every piece of feedback, and take your input very seriously. [ ] [ ] Include my email address so I can be contacted Cancel Submit feedback Saved searches Use saved searches to filter your results more quickly Name [ ] Query [ ] To see all available qualifiers, see our documentation. Cancel Create saved search Sign in Sign up Reseting focus You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session. You switched accounts on another tab or window. Reload to refresh your session. Dismiss alert {{ message }} w3c / epubcheck Public * Notifications You must be signed in to change notification settings * Fork 402 * Star 1.6k The conformance checker for EPUB publications www.w3.org/publishing/epubcheck/ License BSD-3-Clause license 1.6k stars 402 forks Branches Tags Activity Star Notifications You must be signed in to change notification settings * Code * Issues 85 * Pull requests 9 * Actions * Wiki * Security * Insights Additional navigation options * Code * Issues * Pull requests * Actions * Wiki * Security * Insights w3c/epubcheck This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository. main BranchesTags Go to file Code Folders and files Name Name Last commit Last commit message date Latest commit History 1,300 Commits .github/workflows .github/workflows .tx .tx docs docs src src .gitattributes .gitattributes .gitignore .gitignore CHANGELOG.md CHANGELOG.md CODE_OF_CONDUCT.md CODE_OF_CONDUCT.md CONTRIBUTING.md CONTRIBUTING.md Dockerfile Dockerfile LICENSE.md LICENSE.md README.md README.md pom.xml pom.xml w3c.json w3c.json View all files Repository files navigation * README * Code of conduct * BSD-3-Clause license Current Release Github All Releases Downloads CI build with Maven EPUBCheck EPUBCheck is the official conformance checker for EPUB publications. EPUBCheck can be run as a standalone command-line tool or used as a Java library. EPUBCheck is open source software, maintained by the DAISY Consortium on behalf of W3C. We Need Your Support!! Financial support is critical to the development of EPUBCheck, the tool we all use to validate EPUB files. We need to make sure that the resources are adequate to both update the tool and provide for its continued maintenance over the next two years; please help us fund and support EPUBCheck, and join the list of donators! Downloads Check the releases page to get the latest distribution. EPUBCheck v5.1.0 is the latest production-ready release, to be used to validate both EPUB 2 and 3 files. EPUB 3 publications are checked against the EPUB 3.3 specification. Documentation Documentation on how to use EPUBCheck, to contribute to the project or to translate messages is available on the EPUBCheck wiki. Technical discussions are held on our public mailing list. To subscribe to the mailing list, send an email with subject subscribe to public-epubcheck-request@w3.org. To participate in the discussion, simply send an email to public-epubcheck@w3.org. Historical archives of discussions prior to October 2017 are stored at the old EPUBCheck Google Group. Building EPUBCheck Build from sources To build epubcheck from the sources you need Java Development Kit (JDK) 1.7 or above and Apache Maven 3.0 or above installed. Build and run tests: $ mvn clean install Will copy *.jar files and packages to target/ folder... Build using docker To build the epubcheck using docker, use the build command below: $ docker build . -t epubcheck To run the epubcheck image as container, use example command below: # one directory in the host need to be mapped (using docker volume) to /data path # within container. the particular path will be used as a bridge to enable access # over the epub file or the generated output file between host and container. $ docker run -it --rm -v :/data epubcheck --help $ docker run -it --rm -v :/data epubcheck [OPTIONS] # example 1: # execute an epub check over a file located in /home/username/file.epub on the host. # the output will be printed to the console $ docker run -it --rm -v /home/username:/data epubcheck file.epub # example 2: # execute an epub check over a file, and then generate an output file # in /data/output.json within container. # since /data is mapped via volume, then the generated file will be accessible # from /home/username/output.json in the host $ docker run - --rm -v /home/username:/data epubcheck file.epub --json output.json Credits EPUBCheck v5.1.0 was developed by the DAISY Consortium, on behalf of W3C. Initial EPUBCheck development was largely done at Adobe. A significant part of EPUBCheck functionality comes from the schema validation tool Jing, used with schemas from the Nu HTML Checker, IDPF, and DAISY. Past and present EPUBCheck developers include: Romain Deltour, Matt Garrish, Tobias Fischer, Markus Gylling, Steve Antoch, Peter Sorotokin, Thomas Ledoux, Masayoshi Takahashi, Paul Norton, Piotr Kula, Arwen Pond, Liza Daly, Garth Conboy, and several others. Many thanks to the numerous people who have contributed to the evolution of EPUBCheck through bug reports, pull requests, and translations! Donators The following organizations are supporting the development of EPUBCheck by their contribution to the fundraising initiative: MacMillan Learning Google DAISY Publizon A/S Wiley Hachette Livre LearningMate Solutions Inc Voyager Japan, Inc. QA Info Tech W. W. Norton Lumina Datamatics, Inc. Harper Collins Vital Source Verlag C.H. Beck oHG Libreka Zeilenwert Cenveo Publisher Services BookNet Canada License EPUBCheck is made available under the terms of the 3-Clause BSD License About The conformance checker for EPUB publications www.w3.org/publishing/epubcheck/ Topics publishing epub epubcheck epub3 digital-publishing epub-publications Resources Readme License BSD-3-Clause license Code of conduct Code of conduct Activity Custom properties Stars 1.6k stars Watchers 165 watching Forks 402 forks Report repository Releases 23 EPUBCheck v5.1.0 Latest Jul 7, 2023 + 22 releases Contributors 40 * @rdeltour * @tofi86 * @tledoux * @takahashim * @sorotokin * @mattgarrish * @kalaspuffar * @skoji * @lizadaly * @josteinaj * @GrayWolfMT * @skreutzer * @Cuadratin * @GarthConboy + 26 contributors Languages * Java 56.8% * HTML 20.4% * Gherkin 13.6% * CSS 8.4% * XSLT 0.4% * Shell 0.3% * Other 0.1% Footer (c) 2024 GitHub, Inc. Footer navigation * Terms * Privacy * Security * Status * Docs * Contact * Manage cookies * Do not share my personal information You can't perform that action at this time.