1
0
Fork 0
mirror of https://github.com/nix-community/nixvim.git synced 2025-11-16 07:22:49 +01:00
Commit graph

18 commits

Author SHA1 Message Date
Matt Sturgeon
4f03ca05d9 docs/lib: generalise menu impl using module system
Move the mdbook menu rendering code into the module system and
generalise it to apply to multiple "categories" (mdbook parts) and
"types" of category (prefix, suffix, etc).
2025-09-30 16:21:23 +00:00
Matt Sturgeon
f39dd42824
maintaining: init
Add a MAINTAINING.md file where we can document internal maintenance
procedures.
2025-05-23 22:02:06 +01: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
Matt Sturgeon
1c6dd6579a
docs: include function docs
Embed the function reference docs into the main docs website.
2025-05-19 00:19:57 +01:00
Austin Horstman
e8e396558b
docs/user-guide: add lazy-loading.md 2024-12-13 21:19:05 -06:00
Matt Sturgeon
4726334e44
docs: move wrapper options to dedicated sub-pages 2024-10-24 18:32:39 +01: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
traxys
42a7676d5a docs: Add an option search to our documentation 2024-07-25 14:00:35 +00:00
Gaetan Lepage
25338942a7 docs/user-guide: add configuration examples 2024-05-30 21:32:42 +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
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
ad8aa72490
docs: Introduce an user guide (#1121) 2024-02-18 15:56:18 +01:00
traxys
375453feff
docs: Add a short sections on helpers (#1093) 2024-02-14 23:38:26 +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
Renamed from docs/SUMMARY.md (Browse further)