suzanne.soy/wiki.gruntnetwork.com--zimmer
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

README.md

Browse Source
This commit is contained in:
Vadim Shlyakhov 2019-03-12 15:09:11 +03:00 committed by GitHub
parent e65ae2b25b
commit b61a57ad95
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@ -1,8 +1,8 @@
***zimmer*** is a package for creating a [ZIM](http://www.openzim.org/wiki/OpenZIM) files from a Mediawiki-powered wiki.
***zimmer*** is a package for creating [ZIM](http://www.openzim.org/wiki/OpenZIM) files from a Mediawiki-powered wikis.
The package consists of 2 scripts:
- wikizimmer.js — dumps the wiki's articles (name space 0) into a collection of static HTML files.
- wikizimmer.js — dumps the wiki's articles into a collection of static HTML files.
- 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)).
@ -43,7 +43,7 @@ Example:
`wikizimmer https://en.wikivoyage.org/wiki/Pisa`
will dump ***all*** `https://en.wikivoyage.org` articles 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.
will 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.
* Building a ZIM file: