Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/manual.nix
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,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
Expand Down
Binary file added docs/manual/logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions docs/manual/release-notes/rl-0.9.md
Original file line number Diff line number Diff line change
Expand Up @@ -549,6 +549,9 @@
`vim.formatter.conform-nvim.presets` instead of defining formatter
configurations inline.

- 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

Expand Down
25 changes: 25 additions & 0 deletions flake/packages.nix
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down
Loading