{"id":15134682,"url":"https://github.com/vss-devel/zimmer","last_synced_at":"2025-10-23T11:30:46.954Z","repository":{"id":75546014,"uuid":"75726582","full_name":"vss-devel/zimmer","owner":"vss-devel","description":"nodejs ZIM file creator","archived":false,"fork":false,"pushed_at":"2021-04-16T09:21:37.000Z","size":183,"stargazers_count":20,"open_issues_count":1,"forks_count":6,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-01-30T18:03:20.136Z","etag":null,"topics":["mediawiki","openzim","zim"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/vss-devel.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"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":"2016-12-06T11:49:46.000Z","updated_at":"2023-10-24T10:42:49.000Z","dependencies_parsed_at":"2023-06-06T20:45:41.973Z","dependency_job_id":null,"html_url":"https://github.com/vss-devel/zimmer","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vss-devel%2Fzimmer","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vss-devel%2Fzimmer/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vss-devel%2Fzimmer/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vss-devel%2Fzimmer/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/vss-devel","download_url":"https://codeload.github.com/vss-devel/zimmer/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":237811582,"owners_count":19370151,"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":["mediawiki","openzim","zim"],"created_at":"2024-09-26T05:23:46.712Z","updated_at":"2025-10-23T11:30:41.611Z","avatar_url":"https://github.com/vss-devel.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"***zimmer*** is a package for creating [ZIM](http://www.openzim.org/wiki/OpenZIM) files from Mediawiki-powered wikis.\n\nThe package consists of 2 scripts:\n\n- wikizimmer.js — dumps the wiki's articles into a collection of static HTML files.\n\n- zimmer.js — builds a ZIM file from a static HTML files collection. Historically, zimmer.js is mostly a drop-in replacement for [zimwriterfs](https://github.com/wikimedia/openzim/tree/master/zimwriterfs) with a notable exception: it doesn't support *withFullTextIndex* option (index format is [not documented](http://www.openzim.org/wiki/ZIM_Index_Format)).\n\n`wikizimmer.js` unlike to [mwoffliner](https://github.com/openzim/mwoffliner) does not depend on the [Parsoid](https://www.mediawiki.org/wiki/Parsoid) and [Redis](https://redis.io/) and `zimmer.js` unlike to [zimwriterfs](https://github.com/wikimedia/openzim/tree/master/zimwriterfs) doesn't depend on the [zimlib](http://www.openzim.org/wiki/Zimlib).\n\nThe package is relatively easy to install and it can even process some wikis running rather old versions of the Mediawiki engine.\n\n## Installation\nRequirement: `node` version \u003e= 10.4.0\n\n### With npm globally\n\n```\nnpm i -g git+https://github.com/vadp/zimmer\n```\n\nor\n\n### Manually\n\n* Clone *zimmer* from Github or download ZIP\n* Install dependencies: `npm install`\n* Make `wikizimmer.js` and `zimmer.js` executable\n* Optionally symlink both scripts into some directory available in your $PATH:\n\n```\n    ln -s wikizimmer.js \u003csome directory in $PATH\u003e/wikizimmer\n    ln -s zimmer.js \u003csome directory in $PATH\u003e/zimmer\n```\n\n## Usage\n\nRun either of scripts with '--help' switch to see the list of all options available.\n\nThe process of creating a ZIM file from a wiki consists of 2 parts.\n\nExample:\n\n* Dumping a wiki to a local collection of static HTML files:\n\n`wikizimmer https://en.wikivoyage.org/wiki/Pisa`\n\nwill dump all articles from the main name space (aka 0 or '') at the `https://en.wikivoyage.org` to the directory `en.wikivoyage.org`. The URL to a particular page is quite important in this case as this page's styling is used as a template for all other pages in the dump, so wikivoyage listings, for example, are rendered correctly at the static page of the dump.\n\n* Building a ZIM file:\n\n`zimmer --optimg en.wikivoyage.org`\n\nwill pack the content of the `en.wikivoyage.org` into the `en.wikivoyage.org.zim`. zimmer.js with `--optimg` option will recompress the images in the dump to save some space.\n\n**Notes**: \n* wikizimmer.js requires a public access both the normal web interface and to the wiki's API interface.\n* To dump a HTTPS server with a self-signed certificate you need to set an environment variable: `NODE_TLS_REJECT_UNAUTHORIZED=0`\n* The most options of the zimmer.js are optional as it fetches the relevant metadata from the dump created by wikizimmer.js. Perhaps only `--optimg` option is rather important if you want to save some space.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvss-devel%2Fzimmer","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvss-devel%2Fzimmer","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvss-devel%2Fzimmer/lists"}