NotAShelf/nvf
2
1
Fork 0
mirror of https://github.com/NotAShelf/nvf.git synced 2025-09-05 18:01:32 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

docs: update readme & style

Browse source
This commit is contained in:
NotAShelf 2023-02-06 05:27:15 +03:00
commit c2affb9945
No known key found for this signature in database
GPG key ID: 5B5C8895F28445F1
4 changed files with 136 additions and 20 deletions
Download patch file Download diff file Expand all files Collapse all files

2
docs/custom-configs.adoc
View file

@ -18,7 +18,7 @@ The following is an example of a barebones vim configuration with the default th
[source,nix]
----
{
inputs.neovim-flake.url = "github:jordanisaacs/neovim-flake";
inputs.neovim-flake.url = "github:notashelf/neovim-flake";
outputs = {nixpkgs, neovim-flake, ...}: let
system = "x86_64-linux";

6
docs/default-configs.adoc
View file

@ -7,7 +7,7 @@ While you can configure neovim-flake yourself using the builder, here are a few
=== Tidal Cycles
[source,console]
$ nix run github:jordanisaacs/neovim-flake#tidal file.tidal
$ nix run github:notashelf/neovim-flake#tidal file.tidal
Utilizing https://github.com/tidalcycles/vim-tidal[vim-tidal] and mitchmindtree's fantastic https://github.com/mitchmindtree/tidalcycles.nix[tidalcycles.nix] start playing with tidal cycles in a single command.
@ -18,7 +18,7 @@ In your tidal file, type a cycle e.g. `d1 $ s "drum"` and then press _ctrl+enter
=== Nix
[source,console]
$ nix run github:jordanisaacs/neovim-flake#nix test.nix
$ nix run github:notashelf/neovim-flake#nix test.nix
Enables all the of neovim plugins, with language support for specifically Nix. This lets you see what a fully configured neovim setup looks like without downloading a whole bunch of language servers and associated tools.
@ -26,7 +26,7 @@ Enables all the of neovim plugins, with language support for specifically Nix. T
=== Maximal
[source,console]
$ nix shell github:jordanisaacs/neovim-flake#maximal test.nix
$ nix shell github:notashelf/neovim-flake#maximal test.nix
It is the same fully configured neovim as with the <<sec-default-nix,Nix>> config, but with every supported language enabled.

31
docs/release-notes/rl-0.2.adoc Normal file
View file

@ -0,0 +1,31 @@
[[sec-release-0.2]]
== Release 0.2
Release notes for release 0.2
[[sec-release-0.1-changelog]]
=== Changelog
https://github.com/notashelf[notashelf]:
* Added minimap options under `vim.minimap`. The default will be codewindow.nvim.
* Removed hare language support (lsp/tree-sitter/etc). `vim.lsp.hare` is no longer defined. If you use hare and would like it added back, please file an issue.
* <<opt-vim.startPlugins>> & <<opt-vim.optPlugins>> are now an enum of `string` for options sourced from the flake inputs. Users can still provide vim plugin packages.
+
If you are contributing and adding a new plugin, add the plugin name to `availablePlugins` in https://github.com/jordanisaacs/neovim-flake/blob/20cec032bd74bc3d20ac17ce36cd84786a04fd3e/modules/lib/types-plugin.nix[types-plugin.nix].
* `neovimBuilder` has been removed for configuration. Using an overlay is no longer required. See the manual for the new way to configuration.
* Treesitter grammars are now configurable with <<opt-vim.treesitter.grammars>>. Utilizes the nixpkgs `nvim-treesitter` plugin rather than a custom input in order to take advantage of build support of pinned versions. See https://discourse.nixos.org/t/psa-if-you-are-on-unstable-try-out-nvim-treesitter-withallgrammars/23321?u=snowytrees[discourse] for more information. Packages can be found under the `vimPlugins.nvim-treesitter.builtGrammars` namespace.
* <<opt-vim.configRC>> and <<opt-vim.luaConfigRC>> are now of type DAG lines. This allows for ordering of the config. Usage is the same is in home-manager's `home.activation` option.
+
[source,nix]
----
vim.luaConfigRC = lib.nvim.dag.entryAnywhere "config here"
----