nix-community.nixvim/docs/mdbook/SUMMARY.md

# Structure for nixvim docs

- [Home](./index.md)

# User guide

- [Installation](./user-guide/install.md)
- [FAQ](./user-guide/faq.md)
- [Configuration examples](./user-guide/config-examples.md)
- [Lazy Loading](./user-guide/lazy-loading.md)

# Functions

@FUNCTIONS_MENU@

# Platforms

- [Nixvim Platforms](./platforms/index.md)
@PLATFORM_OPTIONS@
	- [Standalone](./platforms/standalone.md)

# Options

@NIXVIM_OPTIONS@

#

---

[Contributing](./CONTRIBUTING.md)
[Maintaining](./MAINTAINING.md)
[NixVim Options Search](./search/index.html)
docs/user-guide: add configuration examples 2024-05-29 14:16:03 +02:00			`# Structure for nixvim docs`
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 13:18:01 +03:30
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			`- [Home](./index.md)`

docs: Introduce an user guide (#1121) 2024-02-18 15:56:18 +01:00			`# User guide`

			`- [Installation](./user-guide/install.md)`
			`- [FAQ](./user-guide/faq.md)`
docs/user-guide: add configuration examples 2024-05-29 14:16:03 +02:00			`- [Configuration examples](./user-guide/config-examples.md)`
docs/user-guide: add lazy-loading.md 2024-12-10 10:36:31 -06:00			`- [Lazy Loading](./user-guide/lazy-loading.md)`
docs: Introduce an user guide (#1121) 2024-02-18 15:56:18 +01:00
docs: include function docs Embed the function reference docs into the main docs website. 2025-05-15 14:24:55 +01:00			`# Functions`

			`@FUNCTIONS_MENU@`

docs: Move standalone usage to modules section 2024-04-01 12:05:46 +01:00			`# Platforms`
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
docs: move `wrapper-options` to summary index page 2024-10-23 17:49:39 +01:00			`- [Nixvim Platforms](./platforms/index.md)`
docs: move wrapper options to dedicated sub-pages 2024-10-23 20:10:59 +01:00			`@PLATFORM_OPTIONS@`
docs: move `wrapper-options` to summary index page 2024-10-23 17:49:39 +01:00			`- [Standalone](./platforms/standalone.md)`
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
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 13:18:01 +03:30			`# Options`

			`@NIXVIM_OPTIONS@`

			`#`

			`---`

			`[Contributing](./CONTRIBUTING.md)`
maintaining: init Add a MAINTAINING.md file where we can document internal maintenance procedures. 2025-05-23 21:22:05 +01:00			`[Maintaining](./MAINTAINING.md)`
docs: Add an option search to our documentation 2024-07-19 20:14:20 +02:00			`[NixVim Options Search](./search/index.html)`