Commit graph

45 commits

Author SHA1 Message Date
Matt Sturgeon
ebdf6ee37b
docs/mdbook: install directly to $out
(cherry picked from commit e3f4a57fb8)
2025-05-24 00:23:15 +01:00
Matt Sturgeon
863d7d5ade
docs: link to all "available" versions of the docs 2024-11-22 09:13:11 +00:00
Matt Sturgeon
99b066ba6d
docs: only set base-href in CI built docs
This reverts commit c12e59ff7c
2024-11-18 19:54:38 +00:00
Matt Sturgeon
cdbda982f0
docs/search: refactor to use override 2024-11-18 17:53:47 +00:00
Matt Sturgeon
a92339d83b
docs: specify site-url
Fixes 404 page's relative links and styling being relative to `/`.
2024-11-11 18:51:14 +00: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
c477b7865e
docs/mdbook: use a fileset union for source 2024-10-24 18:32:15 +01:00
Matt Sturgeon
c2dbf7acf1
docs/mdbook: clean up derivation 2024-10-24 18:32:13 +01:00
Matt Sturgeon
b076f006c6
wrappers: add meta.wrappers options to wrappers
Allows the docs to be a little less hard-coded.

Lays the groundwork for splitting up the platform-specific option docs
on a per-page basis.
2024-10-22 14:15:58 +01:00
Matt Sturgeon
c693500a72
docs: simplify mdbook.nixvimOptions impl 2024-10-22 12:31:56 +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
faa2e6306c docs: Render alerts using mdbook-alerts
Closes #1791
2024-09-10 08:17:21 +00:00
Austin Horstman
ff042dfc93
docs/mdbook: cleanup with lib 2024-09-03 22:12:33 -05:00
Austin Horstman
052ee66dbb
docs/mdbook: move description to bottom
Long descriptions for plugins will shove the plugin's source link and
maintainer information far down the page. Since those are fairly short
and the description is a variable size. Moving below to maintain
consistent placement.
2024-08-23 15:07:21 -05:00
Matt Sturgeon
0bc1699037
docs: call evalModules in one place 2024-08-02 14:38:38 +01:00
Matt Sturgeon
27c4c9c210
lib/modules: init with specialArgs helpers 2024-08-02 14:38:38 +01: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
aad2e32b5a treewide: reformat 2024-07-08 16:24:47 +00: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
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
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
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
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
25338942a7 docs/user-guide: add configuration examples 2024-05-30 21:32:42 +02:00
traxys
62f32bfc71 treewide: Reformat with nixfmt 2024-05-05 22:00:40 +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
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
Gaetan Lepage
cd32dcd50f docs: avoid duplicate maintainers 2024-03-08 08:57:27 +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
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
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
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