Commit graph

144 commits

Author SHA1 Message Date
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
traxys
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
traxys
82a24d0d42
docs: Allow to add an url in the online documentation (#1139)
* plugin/committia: Use correct maintainers import

* plugins/neocord: Remove redyf as the entry is not in the list

* docs: Allow to add an URL to the plugin
2024-02-20 21:20:59 +01:00
traxys
9a14b26e7c
docs: Add an FAQ entry for missing attribute (#1122) 2024-02-19 08:25:10 +01:00
traxys
ad8aa72490
docs: Introduce an user guide (#1121) 2024-02-18 15:56:18 +01:00
traxys
6d7e429537
tests: Introduce a way to disable options when running in tests (#1095)
In our basic template we used to provide a check based on
`mkTestDerivationFromNvim`. The issue with this check (that is handled
correctly internally) is that some plugins _can't_ be used in the test
environment, for example image.nvim like in #1085.

This commit introduces a new function to generate such checks,
`mkTestDerivationFromNixvimModule`, that wraps a nixvim configuration
instead of a built nvim instance.

Then a configuration can rely on the newly added
`helpers.enableExceptInTests` attribute to disable parts of the
configuration depending if it is evaluated in tests or in a real final
configuration.

Resolves #1085
2024-02-15 14:27:45 +01:00
traxys
375453feff
docs: Add a short sections on helpers (#1093) 2024-02-14 23:38:26 +01:00
Gabriel Arazas
0b5800a2a2
docs: clean up descriptions (#1061) 2024-02-11 13:51:34 +01:00
Gaetan Lepage
5d3ed3a09e misc: refactor helpers propagation
Co-authored-by: Robert Hensing <robert@roberthensing.nl>
2024-02-09 14:20:25 +01:00
traxys
507ff5b142
docs: Use a nixpkgs patch instead of copy/pasting nixpkgs functions (#1011)
This makes the code more maintainable, as it only depends on our small
patch, instead of a large number of internals of nixpkgs.
2024-02-03 19:04:09 +01:00
traxys
ca30f8ddac
docs: Add wrapper specific options (#1009)
(Fixes #1002)
2024-02-03 17:45:53 +01:00
traxys
29225c2797
docs: Correctly generate documentation for types either a (submodule ...) (#929)
This requires pulling quite a lot of code from nixpkgs in order to
make the `either` type work correctly, the effects can be seen for
example in the documentation of `ollama.promps` and `ollama.actions`
2024-01-12 23:22:03 +01:00
wolbyte
6efbb5353c docs: terminate build on shell-script error 2023-09-09 17:51:52 +02:00
wolbyte
26b202828f docs: remove whitespaces from filepaths if any 2023-08-30 15:36:44 +02:00
wolbyte
1cc77f4252 docs: ignore option aliases 2023-08-24 13:30:35 +02:00
Wolbyte
ecd593386f
docs: New documentation using mdbook (#471)
* docs: mdbook init

* Separate sub-options into their section

* docs: enable fold

* docs: merge core options into a single section

* doc generation: fix submodules index pages

* docs: add contributing section

* docs: rename 'core' group to 'Neovim Options'

docs: removed the index pages of empty sections

docs: remove obsolete 'mergeFunctionResults' function

* docs: use nix syntax highlighting

* docs: point to the new repo url

* docs: use recursive generation
docs: split submodules into subsections

* docs: fix contributing separator
docs: fix missing submodules docs
2023-08-07 11:48:01 +02:00
Pedro Alves
dd9ec124a2 docs: fix documentation generation 2022-12-29 17:34:54 +00:00
Pedro Alves
4ddd3969e5
nixvim: support standalone nixvim
This represents a major rearchitecture for nixvim, so I'm leaving this up to track the progress for now, and to serve as a reference for any breaking changes during transition.

The main change is, of course, being able to use nixvim standalone. To do this, you should use the new build function, which takes in two arguments: the system architecture (e.g. x86_64-linux) and the configuration. For the new configuration, do not use the programs.nixvim. prefix.

For module development, the main change is that you should no longer prefix your modules with programs.nixvim..
2022-09-18 11:19:23 +01:00
Pedro Alves
929659b7a1 airline: complete documentation 2022-01-12 12:42:12 +00:00
Pedro Alves
eef84178ab docs: Add basic documentation system based on nmd
You can now run `nix build '.#docs'` to build HTML documentation
documenting every single option on nixvim! Fortunately, thanks to
the 'description' field, most options are already documented, but
there are still a fair few that need documenting.

I will be taking care of those in the next few days. When those are
done, I will find a way to automatically rebuild documentation on every
repo push, and also add a PR hook requiring documentation.

Additionally, I will try to find a way to have per-page plugin docs.
2022-01-12 01:44:51 +00:00