Austin Horstman
686507a4cb
config-examples: add khanelivim
2024-07-27 15:14:06 -05:00
Quentin Boyer
c12e59ff7c
doc: Use correct href for nuscht-search
...
This commit also adds a subdirectory in the docs derivation, to have the
same local structure than what is uploaded on github pages.
2024-07-25 18:23:47 +00:00
traxys
42a7676d5a
docs: Add an option search to our documentation
2024-07-25 14:00:35 +00: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
aad2e32b5a
treewide: reformat
2024-07-08 16:24:47 +00:00
Matt Sturgeon
8c44124a1f
docs/user-guide: fix blurb on accessing helpers
...
Fixes #1220
2024-07-08 16:24:07 +01:00
Matt Sturgeon
8b9ba44195
flake: remove getHelpers function
2024-07-08 16:24:07 +01:00
Matt Sturgeon
04a255ed7e
modules/context: init with isDocs
...
Replaced the `isDocs` specialArg added in #1807 with an internal module
option.
We should only use `specialArgs` when absolutely necessary, a module or
`_module.args` is preferred, but those aren't available until `config`
is evaluated so they can't be used for `imports`.
The main problem with `specialArgs` is it makes our modules less
portable.
Luckily that shouldn't be an issue for these context flags.
2024-07-06 11:47:41 +01:00
Matt Sturgeon
edc8602d47
docs: use pkgsDoc to build helpers
2024-07-06 00:32:42 +01:00
Matt Sturgeon
38d43a740f
modules/files: don't include modules in the docs
...
This means we no longer need to spoof the module in the docs implementation.
Instead, we supply the (optional) special arg `isDocs` to `evalModules`.
2024-07-05 17:38:46 +01:00
Matt Sturgeon
2deb61f6a5
modules/top-level: move out of wrappers/modules
2024-07-05 17:20:28 +01:00
Matt Sturgeon
d2afb176ff
modules: refactor module bootstrapping
...
Let's simplify things by defining all modules in `./plugins`, `./modules`
and `./wrappers/modules`.
Instead of currying `pkgs` into a bootstrapping module, we can require
`defaultPkgs` be provided as a special arg.
This refactor allows us to completely remove `flake-modules/modules.nix`!
2024-07-02 19:58:30 +01:00
Matt Sturgeon
55fee7051f
standalone: rename nixvimExtend to extend
...
This is our scope, so there's no need to be explicit.
This also follows the precedent set by `lib.extend`, although that takes
an overlay function.
2024-07-01 15:54:29 +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
Matt Sturgeon
76a8790764
docs/mdbook: only include sub-options of visible options
...
E.g. rename aliases that target the `settings` option shouldn't show the
`settings` sub-options under the `visible=false` alias.
2024-06-25 17:47:38 +01:00
Matt Sturgeon
9e6d690104
docs/mdbook: simplify isVisible
2024-06-25 17:41:42 +01: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
Matt Sturgeon
f8787bd23b
docs: capitalize URL
2024-06-13 05:46:16 +01:00
Matt Sturgeon
5c9b98e64d
docs: render maintainers with github links
...
If a maintainer has their github defined, render their name as a link to
their github profile.
2024-06-13 05:42:49 +01:00
Matt Sturgeon
f34fda8d99
meta: extend meta.nixvimInfo support treewide
...
Rather than supplying a `kind` and `name` pair, we now supply a raw
path.
This path could point to any nixvim option.
2024-06-07 22:22:55 +01:00
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
Sefa Eyeoglu
aa4afbeac2
docs: use lib.extend instead of patching nixpkgs
...
This speeds up evaluation and removes IFD. Additionally, this makes it
easier to maintain these library changes, as we don't have to maintain
static patches.
Signed-off-by: Sefa Eyeoglu <contact@scrumplex.net>
2024-06-06 11:13:52 +01: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
traxys
e035d22b64
standalone: Expose options
...
This can be used to teach `nixd` about NixVim options.
2024-05-15 09:41:21 +02:00
traxys
62f32bfc71
treewide: Reformat with nixfmt
2024-05-05 22:00:40 +02:00
Matt Sturgeon
bd1794e89d
docs: hotfix module guide links
2024-04-01 23:59:25 +02:00
Matt Sturgeon
3f7e6ce850
wrappers: expose config in standalone output ( #1356 )
2024-04-01 17:12:25 +02:00
Matt Sturgeon
14fca449b7
docs: add usage tldr
2024-04-01 15:08:36 +02:00
Matt Sturgeon
226c555d8f
docs: move standalone example to platform usage
2024-04-01 15:08:36 +02:00
Matt Sturgeon
87df94dcbd
docs: Move standalone usage to modules section
2024-04-01 15:08:36 +02:00
traxys
6d1ef5864b
docs: Add a section on module specific options ( #1355 )
...
This commit only adds Home-Manager specific options, we should add
sections for the different kind of modules too.
This is _not_ added to the man docs, as it is more complex. If need
arises we could look into how to do it.
2024-03-30 14:52:32 +01:00
traxys
ce87283dd6
docs: Add a more verbose example on adding the standalone flake ( #1323 )
2024-03-26 00:02:10 +01:00
Matt Sturgeon
d45c30f160
docs: fix moduleDoc being interpreted by bash
...
Including the `moduleDoc` text directly in the `copy_docs` script meant
special chars were interpreted by bash.
Write the text to the nix store so we can `cat` a file instead.
2024-03-23 13:24:58 +01:00
Gaetan Lepage
848543d527
docs: optionally add a description to plugins
2024-03-22 13:15:41 +01:00
Gaetan Lepage
2d4ebda245
docs: swap "url" and "maintainers" in documentation
2024-03-22 13:15:41 +01:00
Matt Sturgeon
7a952a4e32
docs: Add an FAQ entry for keymap aliases ( #1301 )
...
Fixes #1215
2024-03-22 13:02:49 +01:00
Matt Sturgeon
da7c6c41ef
docs: fix github link branch ( #1300 )
...
Nixvim uses "main" rather than "master".
2024-03-22 13:00:43 +01:00
Gaetan Lepage
cd32dcd50f
docs: avoid duplicate maintainers
2024-03-08 08:57:27 +01:00
Gabriel Arazas
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
