aboutsummaryrefslogtreecommitdiff
path: root/readme.md
blob: 9aa43e5df07dae2b95a893d3ab33e6cdb2d3d1d3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
# staticwiki

Yet another low-effort tool for rendering MediaWiki XML dumps to static html
pages.

## Features

- partial wikitext support
- can accept bzip2 compressed streams.
- can output tar stream (could be piped to mksquashfs to recompress without
  writing to disk)
- horribly bad code :)

## Usage

- clone repo
- obtain rustc (tested with nightly)
- `cargo install --path .`
- Get help: `staticwiki --help`
- Convert to squashfs:
  `staticwiki --bzip2 --tar < dump.xml.bz2 | mksquashfs - wiki.sfs -tar -comp zstd`

## License

`AGPL-3.0-only`