Matt Sturgeon
aef7b53979
docs: add status to beta/deprecated version links
Publish every Git push to main to FlakeHub / flakehub-publish (push) Waiting to run
Publish every git push to Flakestry / publish-flake (push) Waiting to run
Documentation / Version info (push) Waiting to run
Documentation / Build (push) Blocked by required conditions
Documentation / Combine builds (push) Blocked by required conditions
Documentation / Deploy (push) Blocked by required conditions
2025-06-17 23:51:07 +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
e3f4a57fb8
docs/mdbook: install directly to $out
...
This fixes a regression introduced by https://github.com/nix-community/nixvim/pull/3349
2025-05-23 21:50:22 +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
Matt Sturgeon
2a4719f275
docs/mdbook: add page ToC
...
https://github.com/slowsage/mdbook-pagetoc
2025-05-17 02:24:00 +01:00
Matt Sturgeon
04c3247144
docs: ensure path is escaped when copying module docs
...
Without escaping the path here, filepaths for options named things like
`*` will result in undefined behaviour.
2025-05-01 00:12:39 +01:00
Matt Sturgeon
9caeb51238
docs: don't remove freeform sub-options
...
This isn't a fully correct fix, but it's much closer to the intended
behaviour.
2025-04-29 09:36:06 +01:00
Matt Sturgeon
7f29e4b2ae
docs/fix-links: init
...
The README/CONTRIBUTING files are authored with GitHub in mind, but we
want to re-use them for the docs website.
Replace the existing simple substitution with a pandoc AST-based filter.
2025-02-13 18:05:54 +00:00
Matt Sturgeon
f584d1d70d
docs/mdbook: support visible = "shallow"
2025-01-29 22:02:34 +00:00
Matt Sturgeon
1654f97a79
docs: use README as a source for the docs
2025-01-19 17:36:14 +00:00
Matt Sturgeon
30842191e0
docs: enable warningsAreErrors
2025-01-17 03:56:59 +00:00
Matt Sturgeon
60e88b870c
docs: treat internal options as invisible
...
`internal` options are intended to be implicitly not `visible`. This is
already handled correctly by the nixos tooling, but our custom tooling
did not correctly handle the edge case.
This lead to strange cases where an internal option is not included in
the docs, but its sub-options were still visible.
2024-12-27 20:34:23 +00:00
Matt Sturgeon
a658e81d71
docs/config-examples: generate dynamically from a toml list
...
This should help to maintain uniformity and hopefully make contributions
easier.
Kept regression tests local to the derivation, however these are also
added to the flake checks.
2024-12-15 17:44:56 +00: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
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
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
traxys
62f32bfc71
treewide: Reformat with nixfmt
2024-05-05 22:00:40 +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
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
