docs: Introduce an user guide (#1121)

This commit is contained in:
traxys 2024-02-18 15:56:18 +01:00 committed by GitHub
parent d656834e3d
commit ad8aa72490
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
6 changed files with 117 additions and 6 deletions

View file

@ -1,5 +1,11 @@
# Structure for nixvim docs
# User guide
- [Installation](./user-guide/install.md)
- [Helpers](./user-guide/helpers.md)
- [FAQ](./user-guide/faq.md)
# Options
@NIXVIM_OPTIONS@
@ -9,4 +15,3 @@
---
[Contributing](./CONTRIBUTING.md)
[Helpers](./helpers.md)

View file

@ -217,7 +217,7 @@ with lib; let
# Copy inputs into the build directory
cp -r --no-preserve=all $inputs/* ./
cp ${../../CONTRIBUTING.md} ./CONTRIBUTING.md
cp ${../helpers.md} ./helpers.md
cp -r ${../user-guide} ./user-guide
# Copy the generated MD docs into the build directory
# Using pkgs.writeShellScript helps to avoid the "bash: argument list too long" error