Added support for customizing ZIM logo #37
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #37 +/- ##
==========================================
+ Coverage 91.85% 92.28% +0.43%
==========================================
Files 4 4
Lines 356 376 +20
Branches 45 48 +3
==========================================
+ Hits 327 347 +20
Misses 25 25
Partials 4 4 ☔ View full report in Codecov by Sentry. |
josephlewis42
force-pushed
the
jl/feat/icons
branch
from
4505ba2
to
2a84b94
Compare
benoit74
requested changes
Nov 4, 2024
josephlewis42
force-pushed
the
jl/feat/icons
branch
3 times, most recently
from
aeff865
to
8db9ae1
Compare
josephlewis42
force-pushed
the
jl/feat/icons
branch
from
8db9ae1
to
3d37df4
Compare
This was referenced Nov 7, 2024
benoit74
reviewed
Nov 7, 2024
josephlewis42
force-pushed
the
jl/feat/icons
branch
from
3d37df4
to
7b219f5
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #32
This change adds a new flag
--logo-formatthat can be used to set a logo for the ZIM from a URL or local file. It supports formatting directives. This means we can fetch files fromfreeCodeCamp/devdocswhich does have 32x32 images (labeled as[email protected]in the repo). I didn't make this the default because they look fine but not great, but the property might still be useful with an S3 bucket or mounted volume.devdocs2zim --output /tmp/devdocs \ --slug=http,lua~5.4,vue~3 \ --logo-format="https://raw.githubusercontent.com/freeCodeCamp/devdocs/refs/heads/main/public/icons/docs/{slug_without_version}/[email protected]"I made the method that fetches and resizes the image static so I think it could be lifted up into
devdocs2zim.