Commit graph

59 commits

Author SHA1 Message Date
Alex Hamilton
c10f60d007 Migrate homeManagerModules uses to homeModules 2025-05-25 12:41:12 -04:00
Gaetan Lepage
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 Tompkins
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 Halkin
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
Nick
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
Nick
99f377335d docs/user-guide/config-examples: add spector700's config 2024-11-24 17:39:06 +00:00
Simon Elsbrock
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
bpatel347
c892aa2073 docs/user-guide/config-examples: remove trailing whitespace 2024-11-11 20:26:53 +00:00
bpatel347
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)
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 Kergaye
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 Hounskul
155353436c Update config-examples.md 2024-06-28 07:53:52 +02:00
Jesse Martinez
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
Gaetan Lepage
a5bc4e645b docs/config-examples: add comment for keeping entries sorted 2024-06-27 11:38:44 +02:00
Roel de Cort
66c8592b31 fix url
didn't render the url correctly, fixed.
2024-06-24 13:28:07 +02:00
Roel de Cort
00f77cbfd0 conform to alphabetical order
Requisted to respect the alphabetical ordering of the list.
2024-06-24 13:28:07 +02:00
Roel de Cort
d0bf018de6 Update config-examples.md with my Nixvim Config
Added my nixvim config to the list of examples
2024-06-24 13:28:07 +02:00
Nikhil Singh
6ac0d2869d docs/config-examples: add niksingh710's config 2024-06-16 23:18:17 +05:30
Gaetan Lepage
f1289fadee misc/post-release 24.05: update workflows 2024-06-06 14:46:34 +02:00
Gaetan Lepage
f02d8c95ac misc: prepare 24.05 release 2024-06-06 14:06:46 +02:00
Mikael Fangel
c0a4c2ef6f docs/user-guide/config-examples: add elythh's config 2024-06-03 10:59:08 +02:00
Gaetan Lepage
0ba2ea5416 helpers: add rawKeysAttrs 2024-05-31 21:53:40 +02:00
Gaetan Lepage
c95b0a5d79 docs/user-guide/config-examples: add MikaelFangel's config 2024-05-31 10:44:53 +02:00
Gaetan Lepage
25338942a7 docs/user-guide: add configuration examples 2024-05-30 21:32:42 +02:00
Matt Sturgeon
bd1794e89d docs: hotfix module guide links 2024-04-01 23:59:25 +02:00