README.md
This commit is contained in:
parent
b736b5e44d
commit
fa9c552e5e
|
@ -1,12 +1,12 @@
|
||||||
***zimmer*** is a package for creating a [ZIM](http://www.openzim.org/wiki/OpenZIM) files, primarily from a Mediawiki-based wiki.
|
***zimmer*** is a package for creating a [ZIM](http://www.openzim.org/wiki/OpenZIM) files from a Mediawiki-powered wiki.
|
||||||
|
|
||||||
The package consists of 2 scripts:
|
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 (name space 0) 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)).
|
- 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)).
|
||||||
|
|
||||||
The major point is that `wikizimmer.js` unlike to [mwoffliner](https://github.com/openzim/mwoffliner) doesn't 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).
|
`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).
|
||||||
|
|
||||||
The package is relatively easy to install and it can even process some wikis running rather old versions of the Mediawiki engine.
|
The package is relatively easy to install and it can even process some wikis running rather old versions of the Mediawiki engine.
|
||||||
|
|
||||||
|
@ -76,6 +76,7 @@ Run either of scripts with '--help' switch to see the list of all options availa
|
||||||
--template [file] non-standard article template
|
--template [file] non-standard article template
|
||||||
--style [file or CSS] additional article CSS style
|
--style [file or CSS] additional article CSS style
|
||||||
--no-default-style don't use default CSS style
|
--no-default-style don't use default CSS style
|
||||||
|
--no-minify don't minify articles
|
||||||
--no-images don't download images
|
--no-images don't download images
|
||||||
--no-css don't page styling
|
--no-css don't page styling
|
||||||
--no-pages don't save downloaded pages
|
--no-pages don't save downloaded pages
|
||||||
|
|
Loading…
Reference in New Issue
Block a user