diff --git a/docs/manual.nix b/docs/manual.nix index 60550b14..7d0b8a73 100644 --- a/docs/manual.nix +++ b/docs/manual.nix @@ -51,6 +51,8 @@ in mkdir -p $out/share/doc cp -r build/* $out/share/doc/ + cp ./logo.png $out/share/doc/assets/logo.png + # Hydra support. Probably not necessary. mkdir -p $out/nix-support/ echo "doc manual $out/share/doc index.html" >> $out/nix-support/hydra-build-products diff --git a/docs/manual/logo.png b/docs/manual/logo.png new file mode 100644 index 00000000..66f7a742 Binary files /dev/null and b/docs/manual/logo.png differ diff --git a/docs/manual/release-notes/rl-0.9.md b/docs/manual/release-notes/rl-0.9.md index 15ef7c3f..6161ae20 100644 --- a/docs/manual/release-notes/rl-0.9.md +++ b/docs/manual/release-notes/rl-0.9.md @@ -462,6 +462,9 @@ - Added coverage support (`vim.utility.crazy-coverage`) via [`crazy-coverage.nvim`](https://github.com/mr-u0b0dy/crazy-coverage.nvim). +- Added new package `docs-zim`, which produces a `.zim` which can be used with + `services.kiwix-serve`. + [vagahbond](https://github.com/vagahbond): [codewindow.nvim]: https://github.com/gorbit99/codewindow.nvim diff --git a/flake/packages.nix b/flake/packages.nix index 5927a3e4..b6f80979 100644 --- a/flake/packages.nix +++ b/flake/packages.nix @@ -118,6 +118,31 @@ fi ''; + docs-zim = pkgs.stdenv.mkDerivation { + name = "nvf-docs-zim"; + dontUnpack = true; + + buildInputs = [pkgs.zim-tools]; + + installPhase = '' + mkdir -p $out + + zimwriterfs \ + --welcome 'index.html' \ + --illustration 'assets/logo.png' \ + --language 'eng' \ + --name 'mvf-manual' \ + --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' \ + --tags 'devdocs;nix' \ + --source 'https://nvf.notashelf.dev/' \ + --scraper 'ndg' \ + ${docs.manual.html}/share/doc $out/nvf.zim + ''; + }; # Exposed neovim configurations nix = buildPkg false; maximal = buildPkg true;