starred/nixvim
1
0
Fork 0
mirror of https://github.com/nix-community/nixvim.git synced 2026-08-28 10:15:49 -05:00
Code Issues Packages Projects Releases Wiki Activity
4,746 Commits 11 Branches 0 Tags
update/main
Commit Graph
81 Commits
Author SHA1 Message Date
Matt Sturgeon 511a763e20 docs: use GFM alert patches from Nixpkgs PR 
Replace our gfm-alerts-to-admonitions plugin and nixos-render-docs
patches with patches from the upstream Nixpkgs PR:
https://github.com/NixOS/nixpkgs/pull/538502
 2026-07-09 17:39:52 +00:00
Matt Sturgeon f60bf47332 modules/nixvim-info: flatten and simplify 
Instead of recursively merging a nested tree, construct a flat map of
"option-path" → {info}.

This should be more efficient to eval, and simpler to introspect.
 2026-06-22 20:39:04 +00:00
Matt SturgeonandGaétan Lepage 643284206b ci/website: simplify docs build 
- Drop branch-specific composite action, target branches via flakeref
- Avoid flake-compat, using `nix build --impure` and `getEnv`
 2026-06-07 21:55:05 +00:00
Matt Sturgeon 70886b715e docs: take defaults from environment variables 
When building with --impure, accept the following environment variables
for docs inputs:
- NIXVIM_DOCS_BASE_HREF → baseHref
- NIXVIM_DOCS_AVAILABLE_VERSIONS → availableVersions

This allows simplifying the `website` CI workflow.
 2026-06-07 20:51:00 +00:00
Matt SturgeonandAustin Horstman a509dd2645 docs/platforms: add standalone-legacy page 
Documents the now-deprecated legacy standalone functions for existing
users.

Co-authored-by: Austin Horstman <khaneliman12@gmail.com>
 2026-06-07 12:49:05 +00:00
Austin HorstmanandMatt Sturgeon 5278f01d0c docs/mdbook: remove redundant alerts 
Says it's included by default in latest version we have in nixpkgs.
 2026-01-24 06:08:49 +00:00
Austin HorstmanandMatt Sturgeon a704c5ac0b docs/mdbook: remove invalid multilingual setting 
https://github.com/rust-lang/mdBook/pull/2775
 2026-01-24 06:08:49 +00:00
Gaetan LepageandMatt Sturgeon 68fd38bfa7 docs/mdbook: remove mdbook-alerts (deprecated and unnecessary) 
'mdbook-alerts' has been removed from nixpkgs because it is deprecated
and natively supported by mdbook since version 0.5.0
 2026-01-24 06:08:49 +00:00
Gaetan LepageandAustin Horstman 1d333fc92e treewide: apply linter suggestions 2025-12-28 04:26:49 +00:00
Matt Sturgeon 79ace278ec docs/mdbook: refactor isVisible's "has visible" check 2025-12-17 20:02:24 +00:00
Matt Sturgeon 5ef378a006 docs/mdbook: handle visible = "transparent" 2025-12-17 20:02:24 +00:00
saygo-pngandMatt Sturgeon 03a51dbf3d treewide: NixVim/nixvim -> Nixvim 
Signed-off-by: saygo-png <saygo.mail@proton.me>
 2025-12-04 23:22:21 +00:00
Matt SturgeonandGaétan Lepage 51daa6bf06 docs: drop "Recent Breaking Changes" section 
They aren't "recent" anymore.
 2025-12-03 09:36:45 +00:00
Matt SturgeonandGaétan Lepage 8d085d4094 docs/mdbook: drop pagetoc 
It is currently not working.

TODO: investigate and fix
 2025-12-03 09:30:43 +00:00
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 334d2eb26e docs/mdbook: general cleanup and renames 
Clean up the docs/mdbook/default.nix expression in an attempt to make it
easier to understand.
 2025-09-16 15:00:04 +00:00
Gaetan LepageandGaétan Lepage cd4fac45a4 docs/mdbook: remove unused highlight.js 2025-08-05 07:40:02 +00:00
Guilhem SaurelandAustin Horstman 3b146040d5 mdbook: add link to repo 2025-06-22 18:54:05 +00:00
Matt Sturgeon aef7b53979 docs: add status to beta/deprecated version links 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 4936f85de3 docs/mdbook: fix user-guide/helpers.html redirect 2025-05-21 14:10:56 +01:00
Matt Sturgeon 0c7e2aa96b docs: user-guide/helpers.md → lib/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
Matt Sturgeon 2a4719f275 docs/mdbook: add page ToC 
https://github.com/slowsage/mdbook-pagetoc
 2025-05-17 02:24:00 +01:00
Farid ZakariaandGitHub ff0ccdf572 docs: add note on "following" nixpkgs input (#3317) 
The use of `follows` in a flake can cause issues even when `useGlobalPackages` is disabled.

Highlight this in the doc.
 2025-05-12 21:58:54 +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
Henry Fraser d4a0db2103 docs: fix typo 2025-04-22 10:08:34 +10: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 85e4e16de8 docs: notify useGlobalPackages breaking change 2025-01-19 13:23: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
Austin Horstman e8e396558b docs/user-guide: add lazy-loading.md 2024-12-13 21:19:05 -06: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