Skip to content

Commit

Permalink
Merge remote-tracking branch 'origin/main' into move_to_libzim8
Browse files Browse the repository at this point in the history
  • Loading branch information
kelvinhammond committed Oct 9, 2023
2 parents 8483bff + af4f200 commit eb2cc7a
Show file tree
Hide file tree
Showing 76 changed files with 17,529 additions and 20,110 deletions.
15 changes: 12 additions & 3 deletions .codecov.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,16 @@
codecov:
notify:
require_ci_to_pass: yes

coverage:
status:
project:
default:
threshold: 0.1%
patch: false
changes: false
threshold: 1%
patch:
default:
target: 90%
threshold: 0%

ignore:
- "test"
9 changes: 5 additions & 4 deletions .editorconfig
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,18 @@ root = true
# Unix-style newlines with a newline ending every file
[*]
charset = utf-8
trim_trailing_whitespace = true
indent_style = space
indent_size = 2
end_of_line = lf
charset = utf-8
trim_trailing_whitespace = true
insert_final_newline = true


# Tab indentation (no size specified)
[Makefile]
indent_style = tab

[*.{c,h,cpp,cpp,hpp}]
indent_size = 4

[*.{js,ts}]
indent_size = 2

3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,5 @@ npm-debug.log
.env
.nyc_output
coverage
mwo-test-*
mwo-test-*
.vscode
5 changes: 3 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -115,8 +115,9 @@ Advices for debugging mwoffliner issues:
output itself. For Wikimedia wikis you can easily generate and
view the output in your browser using the Parsoid REST interface.
Example URLs:
* Mobile (most pages):
https://en.wikivoyage.org/api/rest_v1/page/mobile-sections/Hot_springs
* <del>Mobile (most pages):
https://en.wikivoyage.org/api/rest_v1/page/mobile-sections/Hot_springs</del>
> :warning: **DEPRECATED**: Mobile Content Service endpoints are now deprecated.
* Desktop (main page):
https://es.wikipedia.org/api/rest_v1/page/html/Espa%C3%B1a
3. If the error is with the Parsoid output
Expand Down
18 changes: 18 additions & 0 deletions Changelog
Original file line number Diff line number Diff line change
@@ -1,3 +1,21 @@
1.13.0:
* FIX: Many akwards scenarios around Redis (@uriesk #1756)
* FIX: Wrongly downloaded hidden media files (@pavel-karatsiuba #1780 #849)
* FIX: Incompatibility scenario in hacking the start module (@pavel-karatsiuba #1783)
* FIX: Bad ordering in Javascript module loading at reading time (@pavel-karatsiuba #1766)
* FIX: Unpredictive behaviour depending the order of --format (@pavel-karatsiuba #1826)
* FIX: Broken auto-redirect in a few Wiktionaries (@pavel-karatsiuba #1811)
* FIX: Mosaic selection welcome page with irrelevant pictures (@pavel-karatsiuba #1794)
* FIX: Broken logo downloading because of protocol mismatch (@pavel-karatsiuba #1800)
* UPDATE: Improved container image documentation (@kelson42 #1827)
* UPDATE: Container image using latest versions of Node.js & Redis (@kelson42 #1814)
* UPDATE: Container images only pushed to ghcr.io (@rgaudin #1812)
* UPDATE: Better Axios error reporting (@FledgeXu #1795)
* NEW: Better checking of command line arguments (@pavel-karatsiuba #1823 #1806)
* NEW: Introduce option --customZimLanguage (@kelson42 #1841)
* NEW: Synchronization of UI translations with Translatewiki.net (@kelson42 #116)
* NEW: Threshold specification to the --verbose option (@pavel-karatsiuba #1785)

1.12.1:
* FIX: Bad behaviour because of wrong mime-type in S3 (@kelson42 #1772)
* FIX: Unefficient CI steps (@kelson42 1770)
Expand Down
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
# MWoffliner

MWoffliner is a tool for making a local offline HTML snapshot of any
online [Mediawiki](https://mediawiki.org) instance. It goes through
online [MediaWiki](https://mediawiki.org) instance. It goes through
all online articles (or a selection if specified) and create the
corresponding [ZIM](https://openzim.org) file. It has mainly been
tested against Wikimedia projects like
[Wikipedia](https://wikipedia.org),
[Wiktionary](https://wiktionary.org), ... But it should also work for
any recent Mediawiki.
[Wikipedia](https://wikipedia.org) and
[Wiktionary](https://wiktionary.org) --- but it should also work for
any recent MediaWiki.

Read [CONTRIBUTING.md](./CONTRIBUTING.md) to know more about
MWoffliner development.
Expand Down Expand Up @@ -42,7 +42,7 @@ Run `mwoffliner --help` to get all the possible options.
machine (packages `libjpeg-dev`, `libglu1`, `autoconf`, `automake`, `gcc` on
Debian/Ubuntu)

... and an online Mediawiki with its API available.
... and an online MediaWiki with its API available.

## Usage

Expand All @@ -55,7 +55,7 @@ You might need to run this command with the `sudo` command, depending
how your `npm` is configured.

`npm` permission checking can be a bit annoying for a
newcommer. Please read the documentation carefully if you hit
newcomer. Please read the documentation carefully if you hit
problems: https://docs.npmjs.com/cli/v7/using-npm/scripts#user

Then to run it:
Expand Down
Loading

0 comments on commit eb2cc7a

Please sign in to comment.