diff --git a/doc/book.toml b/doc/book.toml index 841b51e2..649a9e82 100644 --- a/doc/book.toml +++ b/doc/book.toml @@ -3,6 +3,7 @@ title = "Stylix" language = "en" [preprocessor.alerts] +renderers = ["html", "linkcheck"] [output.html] site-url = "/stylix/" @@ -32,3 +33,8 @@ enable = true "/options/modules/nixvim.html" = "./neovim.html" "/options/modules/nvf.html" = "./neovim.html" "/options/modules/vim.html" = "./neovim.html" + +[output.linkcheck] +follow-web-links = false +traverse-parent-directories = false +warning-policy = "error" diff --git a/doc/default.nix b/doc/default.nix index 54563edf..04f09023 100644 --- a/doc/default.nix +++ b/doc/default.nix @@ -10,6 +10,7 @@ stdenvNoCC, mdbook, mdbook-alerts, + mdbook-linkcheck, }: let @@ -618,6 +619,7 @@ stdenvNoCC.mkDerivation { buildInputs = [ mdbook mdbook-alerts + mdbook-linkcheck ]; inherit extraCSS renderedSummary; @@ -636,11 +638,12 @@ stdenvNoCC.mkDerivation { buildPhase = '' runHook preBuild - mdbook build --dest-dir $out + mdbook build runHook postBuild ''; postBuild = '' + cp --recursive book/html $out cat $extraCSSPath >>$out/css/general.css ''; } diff --git a/doc/src/configuration.md b/doc/src/configuration.md index e01deeae..c6f61b10 100644 --- a/doc/src/configuration.md +++ b/doc/src/configuration.md @@ -187,22 +187,22 @@ theme for each user. You may prefer to disable inheritance entirely, and set up the Home Manager version of Stylix yourself if required. Refer to the options -[`stylix.homeManagerIntegration.autoImport`](options/global/nixos.md#stylixhomemanagerintegrationautoimport) +[`stylix.homeManagerIntegration.autoImport`](options/platforms/nixos.md#stylixhomemanagerintegrationautoimport) and -[`stylix.homeManagerIntegration.followSystem`](options/global/nixos.md#stylixhomemanagerintegrationfollowsystem) +[`stylix.homeManagerIntegration.followSystem`](options/platforms/nixos.md#stylixhomemanagerintegrationfollowsystem) to customize this. > [!NOTE] > > There is a special case involving the -> [`stylix.base16Scheme`](options/global/nixos.md#stylixbase16scheme) +> [`stylix.base16Scheme`](options/platforms/home_manager.md#stylixbase16scheme) > option: > > If the wallpaper in a Home Manager configuration is changed, then Home Manager > will stop inheriting the color scheme from NixOS. This allows Home Manager > configurations to use the automatic palette generator without being overridden. > -> Similarly, [`stylix.override`](options/global/nixos.md#stylixoverride) is not inherited +> Similarly, [`stylix.override`](options/platforms/home_manager.md#stylixoverride) is not inherited > if the color scheme is different. ## Turning targets on and off diff --git a/modules/neovim/meta.nix b/modules/neovim/meta.nix index ef53920c..fabd834f 100644 --- a/modules/neovim/meta.nix +++ b/modules/neovim/meta.nix @@ -81,6 +81,7 @@ [Neovim]: https://neovim.io [Nixvim]: https://github.com/nix-community/nixvim#readme + [NixVim Standalone]: https://nix-community.github.io/nixvim/user-guide/install.html#standalone-usage [nvf]: https://github.com/NotAShelf/nvf#readme [Vim]: https://www.vim.org '';