docs: add package for building zim archive#1607
Conversation
snoweuph
requested review from
NotAShelf,
Soliprem and
horriblename
as code owners
| mkdir -p $out/share/doc | ||
| cp -r build/* $out/share/doc/ | ||
|
|
||
| cp ./logo.png $out/share/doc/assets/logo.png |
There was a problem hiding this comment.
I would've put it in the static folder, but its out of the source scope of the package.
|
|
||
| zimwriterfs \ | ||
| --welcome 'index.html' \ | ||
| --illustration 'assets/logo.png' \ |
There was a problem hiding this comment.
this is a non-optional field 💀 and it has to be a png.
|
rebased |
|
good news for the 3 people using ZIM archives |
|
rebased |
NotAShelf
left a comment
NotAShelf
left a comment
There was a problem hiding this comment.
I'm not too sure how I feel about the necessity of this, but let's give this a shot anyway. Left some comments.
There was a problem hiding this comment.
Do we have to duplicate this? I think you can:
- Move README.md and nvf-logo-work.svg to the docs directory
- Reference them instead
There was a problem hiding this comment.
It requires a PNG. So i would need to use imagemagick for conversions.
There was a problem hiding this comment.
It requires a PNG. So i would need to use imagemagick for conversions.
There was a problem hiding this comment.
You can also put a PNG in the assets dir.
There was a problem hiding this comment.
the png has to be in the zim source and relative to it 💀
| mkdir -p $out/share/doc | ||
| cp -r build/* $out/share/doc/ | ||
|
|
||
| cp ./logo.png $out/share/doc/assets/logo.png |
| fi | ||
| ''; | ||
|
|
||
| docs-zim = pkgs.stdenv.mkDerivation { |
There was a problem hiding this comment.
This can be stdenvNoCC since it doesn't need a C compiler.
|
|
||
| buildInputs = [pkgs.zim-tools]; | ||
|
|
||
| installPhase = '' |
There was a problem hiding this comment.
You can use buildCommand here, or disable each unused phase like you did with dontUnpack.
| --title 'NVF Manual' \ | ||
| --description 'nvf is a modular and extensible Neovim configuration framework built for Nix' \ | ||
| --longDescription 'nvf is a highly modular, configurable, extensible and easy to use Neovim configuration framework built for and designed to be used with Nix. Boasting flexibility, robustness and ease of use (among other positive traits), this project allows you to configure a fully featured Neovim instance with a few lines of Nix while leaving all kinds of doors open for integrating Lua in your configurations whether you are a beginner or an advanced user.' \ | ||
| -c 'NotAShelf and NVF Contributors' \ | ||
| -p 'NotAShelf and NVF Contributors' \ |
There was a problem hiding this comment.
Would be nice to make this into a JSON/TOML manifest that ndg can use and can be parsed again here.
|
Like how I talked about this on matrix, I will move this into ndg wrapper. |
2 participants
This adds a
docs-zimpackage, which can be hosted via nixosservices.kiwix-serveSanity Checking
nix fmt).#nix(default package).#maximal.#docs-html(manual, must build).#docs-zim(added in this MR).#docs-linkcheck(optional, please build if adding links)x86_64-linuxaarch64-linuxx86_64-darwinaarch64-darwinAdd a 👍 reaction to pull requests you find important.