Commit Graph
71 Commits
Author SHA1 Message Date
Matt SturgeonandGaétan Lepage 19fd9d7d1e treewide: bump stable 25.11 → 26.05 2026-06-07 20:52:06 +00:00
Matt SturgeonandAustin Horstman a509dd2645 docs/platforms: add standalone-legacy page
Documents the now-deprecated legacy standalone functions for existing
users.

Co-authored-by: Austin Horstman <khaneliman12@gmail.com>
2026-06-07 12:49:05 +00:00
Matt Sturgeon d12c8e43d3 docs/user-guide/install: update "standalone usage" to use evalNixvim 2026-06-07 12:49:05 +00:00
Gaetan LepageandAustin Horstman 1d333fc92e treewide: apply linter suggestions 2025-12-28 04:26:49 +00:00
Zexin YuanandGaétan Lepage d52007581e docs: format nix examples in documentation 2025-12-13 08:51:26 +00:00
Zexin YuanandGaétan Lepage 350ead83e2 docs: clarify lazyLoad.after behavior and mention luaConfig.post 2025-12-12 09:27:51 +00:00
saygo-pngandMatt Sturgeon b65233d5f9 docs: discourage use of follows
Signed-off-by: saygo-png <saygo.mail@proton.me>
2025-12-06 17:59:37 +00:00
saygo-pngandMatt Sturgeon 03a51dbf3d treewide: NixVim/nixvim -> Nixvim
Signed-off-by: saygo-png <saygo.mail@proton.me>
2025-12-04 23:22:21 +00:00
Gaetan Lepage af1ce0d14c treewide: 25.05 -> 25.11 2025-12-01 17:52:21 +00:00
Axel KarjalainenandMatt Sturgeon 4c4cac6445 docs: use official names of NixOS, Home Manager and nix-darwin 2025-10-18 00:05:26 +00:00
Axel KarjalainenandMatt Sturgeon e006fa229c docs: add FAQ entry for plugin modules outside NixVim 2025-10-18 00:05:26 +00:00
Axel KarjalainenandMatt Sturgeon 15b1a1ffca docs: document programs.nixvim submodule 2025-10-18 00:05:26 +00:00
Alex Hamilton c10f60d007 Migrate homeManagerModules uses to homeModules 2025-05-25 12:41:12 -04:00
Gaetan Lepageandnix-infra-bot 764a9b8dda treewide: replace mentions of 24.11 with 25.05 2025-05-24 18:35:23 +10:00
Matt Sturgeon 0c7e2aa96b docs: user-guide/helpers.mdlib/index.md
Move the user-guide to the new lib reference docs.

Added a MDBook redirect entry.

Updated man docs.
2025-05-19 00:19:57 +01:00
Jeremy Fleischman f42468972c Fix typo: nix lists are space separated, not comma separated 2025-04-23 21:11:52 -07:00
Austin Horstman af4483c025 docs/lazy-loading: add extra examples 2025-01-27 10:32:14 -06:00
Quentin Boyer 4751cb55f7 docs/user-guide: Add an entry for collisions with combinePlugins 2025-01-25 18:33:03 +01:00
Matt Sturgeon e4484133d6 docs/user-guide: slightly simplify lib-overlay example 2025-01-17 13:13:40 +00:00
Matt Sturgeon c19daee453 docs/user-guide: document nixvim's lib overlay 2025-01-17 02:23:10 +00:00
Matt Sturgeon b28ebf2535 docs/user-guide: add sub-headings to helpers.md 2025-01-17 02:23:10 +00:00
Dylan TompkinsandGitHub 6830c55d09 fix(docs): typo in install.md 2024-12-20 13:12:37 -08:00
Matt Sturgeon a658e81d71 docs/config-examples: generate dynamically from a toml list
This should help to maintain uniformity and hopefully make contributions
easier.

Kept regression tests local to the derivation, however these are also
added to the flake checks.
2024-12-15 17:44:56 +00:00
Mykola HalkinandMatt Sturgeon 57464f22bb config-examples: add NikolayGalkin 2024-12-14 22:34:29 +00:00
Austin Horstman e8e396558b docs/user-guide: add lazy-loading.md 2024-12-13 21:19:05 -06:00
Gaetan Lepage a35f923d6a treewide: replace mentions of 24.05 with 24.11 2024-11-30 23:17:21 +01:00
6b9d55f936 Update docs/user-guide/config-examples.md
Co-authored-by: Gaétan Lepage <33058747+GaetanLepage@users.noreply.github.com>
2024-11-24 17:39:06 +00:00
Nickandnix-infra-bot 99f377335d docs/user-guide/config-examples: add spector700's config 2024-11-24 17:39:06 +00:00
Simon ElsbrockandGitHub c7b7b6481b docs: no longer using master but main
Tiny update. Noticed the `master` branch does not exist.
2024-11-20 21:44:01 +01:00
bpatel347andnix-infra-bot c892aa2073 docs/user-guide/config-examples: remove trailing whitespace 2024-11-11 20:26:53 +00:00
bpatel347andnix-infra-bot 3415e10419 docs/user-guide/config-examples: add bkp5190 2024-11-11 20:26:53 +00:00
Matt Sturgeon 131e74e560 docs: move wrapper-options to summary index page 2024-10-24 18:32:15 +01:00
Matt Sturgeon cd68b680cd docs: rename modules -> platforms 2024-10-24 18:32:15 +01:00
Matt Sturgeon 0562e519ec docs: refactor wrapper-options docs 2024-10-21 18:36:00 +01:00
Matt Sturgeon 5992a22821 docs: introduce a dedicated homepage
Based of the README for now, with a small additional "welcome to the
docs" section.

Perhaps in future, we could re-use the README.md verbatim? Perhaps with
some additional post-processing.

I think we'd want to dramatically reduce its size first though.

By having a dedicated homepage outside of `user-guide`, this fixes #1625
2024-10-21 18:02:37 +01:00
Giovanni Nicosia (mood)andGitHub 25b8d2ab20 Added kickstarter.nixvim stand-alone flake in the config-examples 2024-10-15 11:39:06 +02:00
Fred Drake d42c804ad5 config-examples: add fred-drake 2024-10-05 21:05:51 -04:00
Zain Kergayeandnix-infra-bot 846e1a321a config-examples: add zainkergaye 2024-10-02 06:54:03 +00:00
Matt Sturgeon 79010edc14 docs/user-guide: update "not found in pkgs" FAQ
Since starting to use `lib.mkPackageOption` throughout nixvim, users
will see a slightly different error message when encountering mismatched
nixpkgs channel errors.

Also fleshed out some recommendations.
2024-09-10 13:46:24 +01:00
Matt Sturgeon 285f6cbd7b lib/*-plugin: use lib.mkPackageOption internally
Instead of maintainers providing an actual `defaultPackage`, they should
specify the pkg name which we'll use when calling `lib.mkPackageOption`.

This makes `mkVimPlugin` and `mkNeovimPlugin` compliant with #1950.
2024-09-04 03:07:49 +01:00
Matt Sturgeon 511a328aa3 wrappers: add our lib to the host's _module.args
Make our "extended" lib available to host modules as `_module.args.nixvimLib`.

We didn't do this before because `helpers` was too generic of a name,
but `nixvimLib` should be ok.

    { nixvimLib, ... }: {
        programs.nixvim.someOption = nixvimLib.nixvim.mkRaw "print('Hi')";
    }
2024-08-22 13:19:59 +01:00
Matt Sturgeon e555ba13b1 docs/helpers: document the "extended" lib 2024-08-22 13:19:59 +01:00
Austin Horstman 59941a5300 config-examples: fix typo 2024-07-27 15:14:06 -05:00
Austin Horstman 686507a4cb config-examples: add khanelivim 2024-07-27 15:14:06 -05:00
Matt Sturgeon 216d64c158 wrappers: make helpers available via lib option
NixOS, HM, & Darwin provide a `lib` option, not to be confused with the
`lib` module arg.

This option is intended for modules to define custom functions without
having to extend nixpkgs lib.

The old option is renamed, if it is accessed it will print:

    trace: Obsolete option `nixvim.helpers' is used. It was renamed to `lib.nixvim'.
2024-07-24 22:02:56 +01:00
traxys e80a8874ac docs: Add a section of *Package options
Documents the fix for #1282

Closes #1282
2024-07-19 22:46:32 +02:00
Matt Sturgeon 8c44124a1f docs/user-guide: fix blurb on accessing helpers
Fixes #1220
2024-07-08 16:24:07 +01:00
Matt Sturgeon c062b976ef flake/legacyPackages: simplify makeNixvim, making it more powerful
Rather than nesting it as `config`, pass `makeNixvim`'s argument through
directly as a module.

This not only simplifies the implementation, but allows users to use
`makeNixvim` for any scenario where `makeNixvimWithModule` would normally
be required.
2024-06-29 22:15:45 +01:00
Ronnie HounskulandGaétan Lepage 155353436c Update config-examples.md 2024-06-28 07:53:52 +02:00
Jesse MartinezandGaétan Lepage 35e837c10b Update config-examples.md
Adding new configuration JMartJonesy/kickstart.nixvim

Update config-examples.md

Fixed alphabetic ordering
2024-06-27 17:04:37 +02:00