{"id":13553043,"url":"https://github.com/w3c/epubcheck","last_synced_at":"2025-05-12T13:14:13.180Z","repository":{"id":11194552,"uuid":"13576006","full_name":"w3c/epubcheck","owner":"w3c","description":"The conformance checker for EPUB publications","archived":false,"fork":false,"pushed_at":"2025-05-09T13:52:51.000Z","size":63224,"stargazers_count":1739,"open_issues_count":78,"forks_count":414,"subscribers_count":167,"default_branch":"main","last_synced_at":"2025-05-12T13:13:51.270Z","etag":null,"topics":["digital-publishing","epub","epub-publications","epub3","epubcheck","publishing"],"latest_commit_sha":null,"homepage":"https://www.w3.org/publishing/epubcheck/","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/w3c.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.md","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2013-10-14T23:29:03.000Z","updated_at":"2025-05-12T07:58:44.000Z","dependencies_parsed_at":"2023-02-10T08:45:45.641Z","dependency_job_id":"b3beae2c-e8b8-4150-ada4-2c9f2c94fe0e","html_url":"https://github.com/w3c/epubcheck","commit_stats":{"total_commits":1201,"total_committers":50,"mean_commits":24.02,"dds":0.4446294754371357,"last_synced_commit":"55aad60015ac644a04f7e2648d9969f80d5922b6"},"previous_names":["idpf/epubcheck"],"tags_count":47,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/w3c%2Fepubcheck","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/w3c%2Fepubcheck/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/w3c%2Fepubcheck/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/w3c%2Fepubcheck/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/w3c","download_url":"https://codeload.github.com/w3c/epubcheck/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253745196,"owners_count":21957319,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["digital-publishing","epub","epub-publications","epub3","epubcheck","publishing"],"created_at":"2024-08-01T12:02:16.148Z","updated_at":"2025-05-12T13:14:13.132Z","avatar_url":"https://github.com/w3c.png","language":"Java","funding_links":[],"categories":["Java","Linters"],"sub_categories":["EPUB"],"readme":"[![Current Release](https://img.shields.io/github/release/w3c/epubcheck.svg)](https://github.com/w3c/epubcheck/releases/latest) [![Github All Releases Downloads](https://img.shields.io/github/downloads/w3c/epubcheck/total.svg?colorB=A9A9A9)](https://github.com/w3c/epubcheck/releases/) [![CI build with Maven](https://github.com/w3c/epubcheck/actions/workflows/maven-ci.yml/badge.svg)](https://github.com/w3c/epubcheck/actions/workflows/maven-ci.yml?query=branch%3Amain)\n\n\n\n\n\nEPUBCheck\n=========\n\nEPUBCheck is the official conformance checker for EPUB publications.\nEPUBCheck can be run as a standalone command-line tool or used as a Java library.\n\nEPUBCheck is open source software, maintained by the [DAISY Consortium](http://www.daisy.org) on behalf of [W3C](https://www.w3.org/publishing/epubcheck_fundraising).\n\n\n**We Need Your Support!!**  \nFinancial support is critical to the development of EPUBCheck, the tool we all use to validate EPUB files.\nWe 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;\nplease [help us fund and support EPUBCheck](https://www.w3.org/publishing/epubcheck_fundraising), and join the [list of donators](#donators)!\n\n\n## Downloads\n\nCheck the [releases page](https://github.com/w3c/epubcheck/releases) to get the latest distribution.\n\n[EPUBCheck v5.2.1](https://github.com/w3c/epubcheck/releases/tag/v5.2.1) 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](https://www.w3.org/TR/epub-33/) specification.\n\n## Documentation\n\nDocumentation on how to **use** EPUBCheck, to **contribute** to the project or to **translate** messages is available on the [EPUBCheck wiki](https://github.com/w3c/epubcheck/wiki).\n\nTechnical discussions are held on our public [mailing list](https://lists.w3.org/Archives/Public/public-epubcheck/). To subscribe to the mailing list, send an email with subject `subscribe` to [public-epubcheck-request@w3.org](mailto:public-epubcheck-request@w3.org?subject=subscribe). To participate in the discussion, simply send an email to [public-epubcheck@w3.org](mailto:public-epubcheck-request@w3.org).\n\nHistorical archives of discussions prior to October 2017 are stored at the old [EPUBCheck Google Group](https://groups.google.com/forum/#!forum/epubcheck).\n\n## Building EPUBCheck\n\n### Build from sources\n\nTo build epubcheck from the sources you need Java Development Kit (JDK) 1.7 or above and [Apache Maven](http://maven.apache.org/) 3.0 or above installed.\n\nBuild and run tests:\n\n```\n$ mvn clean install\n```\nWill copy `*.jar` files and packages to `target/` folder...\n\n### Build using docker\n\nTo build the epubcheck using docker, use the build command below:\n\n```bash\n$ docker build . -t epubcheck\n```\n\nTo run the epubcheck image as container, use example command below:\n\n```bash\n# one directory in the host need to be mapped (using docker volume) to /data path\n# within container. the particular path will be used as a bridge to enable access\n# over the epub file or the generated output file between host and container.\n$ docker run -it --rm -v \u003cdirectory\u003e:/data epubcheck --help\n$ docker run -it --rm -v \u003cdirectory\u003e:/data epubcheck \u003cepub-file\u003e [OPTIONS]\n\n# example 1:\n# execute an epub check over a file located in /home/username/file.epub on the host.\n# the output will be printed to the console\n$ docker run -it --rm -v /home/username:/data epubcheck file.epub\n\n# example 2:\n# execute an epub check over a file, and then generate an output file\n# in /data/output.json within container.\n# since /data is mapped via volume, then the generated file will be accessible\n# from /home/username/output.json in the host\n$ docker run - --rm -v /home/username:/data epubcheck file.epub --json output.json\n```\n\n## Credits\n\nEPUBCheck is currently maintained by [the DAISY Consortium](https://www.daisy.org/), on behalf of W3C.\n\nInitial EPUBCheck development was largely done at [Adobe](https://www.adobe.com/).\nA significant part of EPUBCheck functionality comes from the schema validation tool [Jing](https://relaxng.org/jclark/jing.html), used with schemas from the [Nu HTML Checker](https://validator.github.io/validator/), [IDPF](https://idpf.org), and [DAISY](https://www.daisy.org/). \n\nPast and present EPUBCheck developers include:\nRomain 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](https://github.com/w3c/epubcheck/graphs/contributors).\n\nMany thanks to the numerous people who have contributed to the evolution of EPUBCheck through bug reports, pull requests, and translations!\n\n## Donators\n\nThe following organizations are supporting the development of EPUBCheck by their contribution to the [fundraising initiative](https://www.w3.org/publishing/epubcheck_fundraising):\n\n\u003cp float=\"left\"\u003e\n  \u003ca href=\"https://www.macmillanlearning.com\"\u003e\u003cimg alt=\"MacMillan Learning\" src=\"https://www.w3.org/publishing/donators_logos/MacLearn_logo_cmyk.png\" width=\"200\" hspace=\"20\" align=\"middle\"/\u003e\u003c/a\u003e\n  \u003ca href=\"https://www.google.com\"\u003e\u003cimg alt=\"Google\" src=\"https://www.w3.org/publishing/donators_logos/Google.png\" width=\"400\" hspace=\"20\" align=\"middle\"/\u003e\u003c/a\u003e\n  \u003ca href=\"http://daisy.org\"\u003e\u003cimg alt=\"DAISY\" src=\"https://www.w3.org/publishing/donators_logos/daisy_high.jpg\" width=\"100\" hspace=\"20\" align=\"middle\"/\u003e\u003c/a\u003e\n  \u003ca href=\"https://pubhub.dk\"\u003e\u003cimg alt=\"Publizon A/S\" src=\"https://www.w3.org/publishing/donators_logos/publizon-logo.jpg\" width=\"100\" hspace=\"20\" align=\"middle\"/\u003e\u003c/a\u003e\n  \u003ca href=\"https://www.wiley.com\"\u003e\u003cimg alt=\"Wiley\" src=\"https://www.w3.org/publishing/donators_logos/Wiley_Wordmark_black.png\" width=\"200\" hspace=\"20\" align=\"middle\"/\u003e\u003c/a\u003e\n  \u003ca href=\"https://www.hachette.com\"\u003e\u003cimg alt=\"Hachette Livre\" src=\"https://www.w3.org/publishing/donators_logos/Hachette%20Livre.jpg\" width=\"300\" hspace=\"20\" align=\"middle\"/\u003e\u003c/a\u003e\n  \u003ca href=\"https://www.learningmate.com\"\u003e\u003cimg alt=\"LearningMate Solutions Inc\" src=\"https://www.w3.org/publishing/donators_logos/LearningMate%20Logo.png\" width=\"100\" hspace=\"20\" align=\"middle\"/\u003e\u003c/a\u003e\n  \u003ca href=\"https://www.voyager.co.jp\"\u003e\u003cimg alt=\"Voyager Japan, Inc.\" src=\"https://www.w3.org/publishing/donators_logos/rectangle_VJstar_logo_512.jpg\" width=\"100\" hspace=\"20\" align=\"middle\"/\u003e\u003c/a\u003e\n  \u003ca href=\"https://qainfotech.com\"\u003e\u003cimg alt=\"QA Info Tech\" src=\"https://www.w3.org/publishing/donators_logos/QA%20InfoTech%20Logo%20PNG%20Format.png\" width=\"200\" hspace=\"20\" align=\"middle\"/\u003e\u003c/a\u003e\n  \u003ca href=\"https://wwnorton.com\"\u003e\u003cimg alt=\"W. W. Norton\" src=\"https://www.w3.org/publishing/donators_logos/NortonLogo_notagline.jpg\" width=\"100\" hspace=\"20\" align=\"middle\"/\u003e\u003c/a\u003e\n  \u003ca href=\"https://luminadatamatics.com\"\u003e\u003cimg alt=\"Lumina Datamatics, Inc.\" src=\"https://www.w3.org/publishing/donators_logos/Datamatics_logo.jpg\" width=\"100\" hspace=\"20\" align=\"middle\"/\u003e\u003c/a\u003e\n  \u003ca href=\"https://www.harpercollins.com\"\u003e\u003cimg alt=\"Harper Collins\" src=\"https://www.w3.org/publishing/donators_logos/HarperCollins.png\" width=\"200\" hspace=\"20\" align=\"middle\"/\u003e\u003c/a\u003e\n  \u003ca href=\"https://www.vitalsource.com\"\u003e\u003cimg alt=\"Vital Source\" src=\"https://www.w3.org/publishing/donators_logos/VS_Logo_HOR_Ingram_Tag(RGB).jpg\" width=\"300\" hspace=\"20\" align=\"middle\"/\u003e\u003c/a\u003e\n  \u003ca href=\"https://www.beck.de/\"\u003e\u003cimg alt=\"Verlag C.H. Beck oHG\" src=\"https://www.w3.org/publishing/donators_logos/Beck_LogoVektor_sw.jpg\" width=\"100\" hspace=\"20\" align=\"middle\"/\u003e\u003c/a\u003e\n  \u003ca href=\"https://info.libreka.de\"\u003e\u003cimg alt=\"Libreka\" src=\"https://www.w3.org/publishing/donators_logos/logo_libreka.png\" width=\"100\" hspace=\"20\" align=\"middle\"/\u003e\u003c/a\u003e\n  \u003ca href=\"https://zeilenwert.de\"\u003e\u003cimg alt=\"Zeilenwert\" src=\"https://www.w3.org/publishing/donators_logos/logo_zeilenwert.jpg\" width=\"100\" hspace=\"20\" align=\"middle\"/\u003e\u003c/a\u003e\n  \u003ca href=\"https://www.cenveopublisherservices.com\"\u003e\u003cimg alt=\"Cenveo Publisher Services\" src=\"https://www.w3.org/publishing/donators_logos/CVO%20Pub%20Serv_Logo.jpg\" width=\"100\" hspace=\"20\" align=\"middle\"/\u003e\u003c/a\u003e\n  \u003ca href=\"https://www.booknetcanada.ca\"\u003e\u003cimg alt=\"BookNet Canada\" src=\"https://www.w3.org/publishing/donators_logos/BNC_Logo_Horizontal_RGB_1000px.png\" width=\"100\" hspace=\"20\" align=\"middle\"/\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n## License\n\nEPUBCheck is made available under the terms of the [3-Clause BSD License](http://opensource.org/licenses/BSD-3-Clause)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fw3c%2Fepubcheck","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fw3c%2Fepubcheck","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fw3c%2Fepubcheck/lists"}