Commit Graph
38 Commits
Author SHA1 Message Date
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
Gaetan LepageandGaétan Lepage a5bc4e645b docs/config-examples: add comment for keeping entries sorted 2024-06-27 11:38:44 +02:00
Roel de CortandGaétan Lepage 66c8592b31 fix url
didn't render the url correctly, fixed.
2024-06-24 13:28:07 +02:00
Roel de CortandGaétan Lepage 00f77cbfd0 conform to alphabetical order
Requisted to respect the alphabetical ordering of the list.
2024-06-24 13:28:07 +02:00
Roel de CortandGaétan Lepage 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 LepageandGaétan Lepage f1289fadee misc/post-release 24.05: update workflows 2024-06-06 14:46:34 +02:00
Gaetan LepageandGaétan Lepage f02d8c95ac misc: prepare 24.05 release 2024-06-06 14:06:46 +02:00
Mikael FangelandGaétan Lepage c0a4c2ef6f docs/user-guide/config-examples: add elythh's config 2024-06-03 10:59:08 +02:00
Gaetan LepageandGaétan Lepage 0ba2ea5416 helpers: add rawKeysAttrs 2024-05-31 21:53:40 +02:00
Gaetan LepageandGaétan Lepage c95b0a5d79 docs/user-guide/config-examples: add MikaelFangel's config 2024-05-31 10:44:53 +02:00
Gaetan LepageandGaétan Lepage 25338942a7 docs/user-guide: add configuration examples 2024-05-30 21:32:42 +02:00
Matt SturgeonandGaétan Lepage bd1794e89d docs: hotfix module guide links 2024-04-01 23:59:25 +02:00
Matt SturgeonandGaétan Lepage 14fca449b7 docs: add usage tldr 2024-04-01 15:08:36 +02:00
Matt SturgeonandGaétan Lepage 226c555d8f docs: move standalone example to platform usage 2024-04-01 15:08:36 +02:00
Matt SturgeonandGaétan Lepage 87df94dcbd docs: Move standalone usage to modules section 2024-04-01 15:08:36 +02:00
traxysandGitHub ce87283dd6 docs: Add a more verbose example on adding the standalone flake (#1323) 2024-03-26 00:02:10 +01:00
Matt SturgeonandGitHub 7a952a4e32 docs: Add an FAQ entry for keymap aliases (#1301)
Fixes #1215
2024-03-22 13:02:49 +01:00
Gabriel ArazasandGitHub d6a66851fe wrappers: add env-specific config as part of NixVim module (#1075)
* wrappers: add env-specific config as part of NixVim module

* docs: add section for env-specific module arguments
2024-02-22 08:24:13 +01:00
traxysandGitHub 9cd3721adf standalone: Allow to extend a standalone derivation with a new module (#1142)
This adds the `nixvimExtend` attribute to the generated standalone
derivation, this attribute takes a module as an argument and returns a
new standalone derivation with the initial module & the extended module
merged together.
2024-02-22 08:22:21 +01:00
traxysandGitHub 9a14b26e7c docs: Add an FAQ entry for missing attribute (#1122) 2024-02-19 08:25:10 +01:00
traxysandGitHub ad8aa72490 docs: Introduce an user guide (#1121) 2024-02-18 15:56:18 +01:00