docs: format nix examples in documentation

CONTRIBUTING.md

@@ -198,11 +198,13 @@ For example this option will render something like:
 > **Example**: `"Hello, world!"`
 
 ```nix
-foo = lib.mkOption {
+{
+  foo = lib.mkOption {
     type = lib.types.nullOr lib.types.str;
     description = "Some string";
     default = null;
     example = "Hello, world!";
+  };
 }
 ```
 
@@ -222,7 +224,7 @@ example = lib.literalExpression ''
   {
     foo = lib.nixvim.mkRaw "foo";
   }
-''
+'';
 ```
 
 Another example where `literalExpression` is beneficial is when your example includes multi-line strings.
@@ -238,13 +240,13 @@ example = lib.literalExpression ''
       several lines!
     ''';
   }
-''
+'';
 ```
 
 On very rare occasions, you may wish to include some non-code text within your example. This can be done by wrapping a markdown string with `lib.literalMD`.
 E.g:
 
-`````nix
+````nix
 example = lib.literalMD ''
   This will render as normal text.
 
@@ -253,8 +255,8 @@ example = lib.literalMD ''
   ```nix
   This will render as nix code.
   ```
-''
-`````
+'';
+````
 
 See also: [Writing NixOS Modules: Option Declarations](https://nixos.org/manual/nixos/unstable/#sec-option-declarations) (NixOS Manual).
 

docs/lib/index.md

@@ -26,6 +26,7 @@ in
 ```
 
 The extended `lib` is also accessible in the `lib` module argument in the `programs.nixvim` submodule:
+
 ```nix
 {
   programs.nixvim =

docs/platforms/standalone.md

@@ -38,7 +38,7 @@ This function is recursive, meaning that it can be applied an arbitrary number o
   second = first.extend {extraConfigLua = "-- second stage";};
   third = second.extend {extraConfigLua = "-- third stage";};
 in
-    third
+third
 ```
 
 This will generate a `init.lua` that will contain the comments from each stages:
@@ -61,10 +61,10 @@ Given a Nixvim derivation it is possible to access the module options using `<de
 This can be useful to configure `nixd` for example:
 
 ```nix
-plugins.lsp.servers.nixd = {
+{
+  plugins.lsp.servers.nixd = {
     enable = true;
-    settings = {
-        options.nixvim.expr = ''(builtins.getFlake "/path/to/flake").packages.${system}.neovimNixvim.options'';
+    settings.options.nixvim.expr = ''(builtins.getFlake "/path/to/flake").packages.${system}.neovimNixvim.options'';
   };
-};
+}
 ```

docs/user-guide/faq.md

@@ -19,6 +19,7 @@ lib.nixvim.plugins.mkNeovimPlugin {
 ```
 
 Import it into your Nixvim configuration and configure it:
+
 ```nix
 {
   # Remove this `programs.nixvim` wrapper for standalone configurations
@@ -36,7 +37,8 @@ Import it into your Nixvim configuration and configure it:
 This is straightforward too, you can add the following to `extraPlugins` for a plugin hosted on GitHub:
 
 ```nix
-extraPlugins = [(pkgs.vimUtils.buildVimPlugin {
+{
+  extraPlugins = [(pkgs.vimUtils.buildVimPlugin {
     name = "my-plugin";
     src = pkgs.fetchFromGitHub {
         owner = "<owner>";
@@ -44,7 +46,8 @@ extraPlugins = [(pkgs.vimUtils.buildVimPlugin {
         rev = "<commit hash>";
         hash = "<nix NAR hash>";
     };
-})];
+  })];
+}
 ```
 
 The [nixpkgs manual](https://nixos.org/manual/nixpkgs/stable/#managing-plugins-with-vim-packages) has more information on this.
@@ -98,7 +101,8 @@ This is so that Nixvim is built against the same nixpkgs revision we're using in
 You could use the builtin [`map`] function (or similar) to do something like this:
 
 ```nix
-keymaps =
+{
+  keymaps =
     (builtins.map (key: {
       inherit key;
       action = "<some-action>";
@@ -107,12 +111,14 @@ keymaps =
     ++ [
       # Other keymaps...
     ];
+}
 ```
 
 This maps a list of keys into a list of similar [`keymaps`]. It is equivalent to:
 
 ```nix
-keymaps = [
+{
+  keymaps = [
     {
       key = "<key-1>";
       action = "<some-action>";
@@ -129,7 +135,8 @@ keymaps = [
       options.desc = "My cool keymapping";
     }
     # Other keymaps...
-];
+  ];
+}
 ```
 
 [`map`]: https://nixos.org/manual/nix/stable/language/builtins#builtins-map

docs/user-guide/install.md

@@ -27,6 +27,7 @@ let
     # When using a different channel you can use `ref = "nixos-<version>"` to set it here
   });
 in
+# configurations...
 ```
 
 When using flakes you can simply add `nixvim` to the inputs:

docs/user-guide/lazy-loading.md

@@ -55,35 +55,32 @@ is done through the `lazyLoad.settings` option.
 Load on command:
 
 ```nix
-plugins = {
-  grug-far = {
+{
+  plugins.grug-far = {
     enable = true;
-    lazyLoad = {
-      settings = {
-        cmd = "GrugFar";
+    lazyLoad.settings.cmd = "GrugFar";
   };
-    };
-  };
-};
+}
 ```
 
 Load on file type:
 
 ```nix
-plugins = {
-  glow = {
+{
+  plugins.glow = {
     enable = true;
     lazyLoad.settings.ft = "markdown";
   };
+}
 ```
 
 Different load conditions:
 
 ```nix
-plugins.toggleterm = {
+{
+  plugins.toggleterm = {
     enable = true;
-  lazyLoad = {
-    settings = {
+    lazyLoad.settings = {
       cmd = "ToggleTerm";
       keys = [
         "<leader>tg"
@@ -91,15 +88,15 @@ plugins.toggleterm = {
       ];
     };
   };
-};
+}
 ```
 
 Load on keymap with dependency:
 
 ```nix
+{
   plugins.dap-ui = {
     enable = true;
-
     lazyLoad.settings = {
       # We need to access nvim-dap in the after function.
       before.__raw = ''
@@ -121,6 +118,7 @@ Load on keymap with dependency:
       ];
     };
   };
+}
 ```
 
 ### Colorschemes
@@ -130,19 +128,22 @@ set up the `colorscheme` trigger to the name of the `colorscheme` so that it is
 lazy loaded when the `colorscheme` is requested.
 
 ```nix
-colorscheme = "catppuccin";
-colorschemes.catppuccin = {
+{
+  colorscheme = "catppuccin";
+  colorschemes.catppuccin = {
     enable = true;
     lazyLoad.enable = true;
-};
+  };
+}
 ```
 
 To configure special integrations after `catppuccin` has been set up (while
 still letting Nixvim manage lazy loading and the default `after`):
 
 ```nix
-colorscheme = "catppuccin";
-colorschemes.catppuccin = {
+{
+  colorscheme = "catppuccin";
+  colorschemes.catppuccin = {
     enable = true;
     lazyLoad.enable = true;
   
@@ -153,12 +154,13 @@ colorschemes.catppuccin = {
       -- derive bufferline highlights or similar settings from it.
       require('lz.n').trigger_load("bufferline.nvim")
     '';
-};
+  };
   
-# Configure bufferline to load after catppuccin
-plugins.bufferline = {
+  # Configure bufferline to load after catppuccin
+  plugins.bufferline = {
     enable = true;
     settings.highlights.__raw = "require('catppuccin.special.bufferline').get_theme()";
     lazyLoad.settings.lazy = true; # Lazy load manually
-};
+  };
+}
 ```