mirror of
https://github.com/NotAShelf/nvf.git
synced 2024-11-01 11:01:15 +00:00
docs: release notes for 0.2 & update manpage license year
This commit is contained in:
NotAShelf
parent
bbfa3e5c5b
commit
bebc9941ad
6 changed files with 118 additions and 34 deletions
|
|
@ -26,11 +26,12 @@ Enables all the of neovim plugins, with language support for specifically Nix. T
|
|||
=== Maximal
|
||||
|
||||
[source,console]
|
||||
$ nix shell github:notashelf/neovim-flake#maximal test.nix
|
||||
$ nix run 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.
|
||||
|
||||
[NOTE]
|
||||
====
|
||||
Running the maximal config will download *a lot* of packages as it is downloading language servers, formatters, and more.
|
||||
Running the maximal config will download *a lot* of packages, as it will be downloading language servers, formatters, and more. You are recommended to use the binary cache if
|
||||
using the default configs.
|
||||
====
|
||||
|
|
|
|||
|
|
@ -22,7 +22,7 @@
|
|||
}
|
||||
++ [scrubbedPkgsModule];
|
||||
moduleRootPaths = [./..];
|
||||
mkModuleUrl = path: "https://github.com/jordanisaacs/neovim-flake/blob/main/${path}#blob-path";
|
||||
mkModuleUrl = path: "https://github.com/notashelf/neovim-flake/blob/main/${path}#blob-path";
|
||||
channelName = "neovim-flake";
|
||||
docBook.id = "neovim-flake-options";
|
||||
};
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@
|
|||
<info>
|
||||
<author><personname>neovim-flake contributors</personname></author>
|
||||
<copyright>
|
||||
<year>2021–2023</year>
|
||||
<year>2023</year>
|
||||
<holder>neovim-flake contributors</holder>
|
||||
</copyright>
|
||||
</info>
|
||||
|
|
|
|||
|
|
@ -3,6 +3,42 @@
|
|||
|
||||
The following are the neovim plugins used within neovim-flake. Some plugins are explicitly enabled by the user, while others are enabled implicitly.
|
||||
|
||||
|
||||
[[sec-plugins-buffer]]
|
||||
=== Coding Assistants
|
||||
|
||||
* https://github.com/zbirenbaum/copilot.lua[copilot.lua] a lua replacement for github.vim, the license nightmare AI assistant
|
||||
* https://github.com/codota/tabnine-nvim[tabnine-nvim] neovim plugin for the more ethically acceptable AI assistant TabNine
|
||||
|
||||
[[sec-plugins-buffer]]
|
||||
=== Buffers
|
||||
|
||||
* https://github.com/akinsho/bufferline.nvim[nvim-bufferline-lua] a buffer line with tab integration
|
||||
* https://github.com/famiu/bufdelete.nvim[bufdelete-nvim] delete buffers without losing window layout
|
||||
|
||||
[[sec-plugins-commenting]]
|
||||
=== Commenting
|
||||
|
||||
* https://github.com/b3nj5m1n/kommentary[kommentary] neovim plugin to comment text in and out, written in lua. Supports commenting out the current line, a visual selection and a motion
|
||||
* https://github.com/folke/todo-comments.nvim[todo-comments.nvim] plugin to highlight and search for todo comments like TODO, HACK, BUG in your codebase
|
||||
|
||||
[[sec-plugins-completions]]
|
||||
=== Completions
|
||||
|
||||
* https://github.com/hrsh7th/nvim-cmp[nvim-cmp] a completion engine that utilizes sources
|
||||
** https://github.com/hrsh7th/cmp-buffer[cmp-buffer] a source for buffer words
|
||||
** https://github.com/hrsh7th/cmp-nvim-lsp[cmp-nvim-lsp] a source for builtin LSP client
|
||||
** https://github.com/hrsh7th/cmp-vsnip[cmp-vsnip] a source for vim-vsnip autocomplete
|
||||
** https://github.com/hrsh7th/cmp-path[cmp-path] a source for path autocomplete
|
||||
** https://github.com/ray-x/cmp-treesitter[cmp-treesitter] treesitter nodes autcomplete
|
||||
|
||||
[[sec-plugins-dashboard]]
|
||||
=== Dashboard
|
||||
|
||||
* https://github.com/glepnir/dashboard-nvim[dashboard.nvim] fancy and blazing fast start screen plugin for Neovim
|
||||
* https://github.com/goolord/alpha-nvim[alpha.nvim] a fast and fully programmable greeter for neovim
|
||||
* https://github.com/mhinz/vim-startify[vim-startify] a fancy start screen for {neo,}vim
|
||||
|
||||
[[sec-plugins-server]]
|
||||
=== Language Server
|
||||
|
||||
|
|
@ -14,12 +50,6 @@ The following are the neovim plugins used within neovim-flake. Some plugins are
|
|||
* https://github.com/ray-x/lsp_signature.nvim[lsp-signature] show function signatures as you type
|
||||
* https://github.com/onsails/lspkind-nvim[lspkind-nvim] for pictograms in lsp (with support for nvim-cmp)
|
||||
|
||||
[[sec-plugins-buffer]]
|
||||
=== Buffers
|
||||
|
||||
* https://github.com/akinsho/bufferline.nvim[nvim-bufferline-lua] a buffer line with tab integration
|
||||
* https://github.com/famiu/bufdelete.nvim[bufdelete-nvim] delete buffers without losing window layout
|
||||
|
||||
[[sec-plugins-statuslines]]
|
||||
=== Statuslines
|
||||
|
||||
|
|
@ -44,8 +74,43 @@ The following are the neovim plugins used within neovim-flake. Some plugins are
|
|||
=== Visuals
|
||||
|
||||
* https://github.com/lukas-reineke/indent-blankline.nvim[indent-blankline] for indentation guides
|
||||
* https://github.com/kyazdani42/nvim-web-devicons[nvim-web-devicons] Plugins and colors for icons. Requires patched font
|
||||
* https://github.com/declancm/cinnamon.nvim[cinnamon.nvim] Smooth scrolling for ANY movement command
|
||||
* https://github.com/kyazdani42/nvim-web-devicons[nvim-web-devicons] plugins and colors for icons. Requires patched font
|
||||
* https://github.com/declancm/cinnamon.nvim[cinnamon.nvim] smooth scrolling for ANY movement command
|
||||
* https://github.com/nvim-cursorline[nvim-cursorline] a plugin for neovim that highlights cursor words and lines
|
||||
* https://github.com/petertriho/nvim-scrollbar[nvim-scrollbar] a scrollbar plugin for neovim
|
||||
* https://github.com/Eandrju/cellular-automaton.nvim[cellular-automatan] a vanity to plugin to help you procrastinate more efficiently
|
||||
|
||||
[[sec-plugins-minimap]]
|
||||
=== Minimap
|
||||
|
||||
* https://github.com/wfxr/minimap.vim[minimap.vim] a blazing fast minimap plugin for neovim. Depends on code-minimap
|
||||
* https://github.com/gorbit99/codewindow.nvim[codewindow.nvim] a simple, configurable minimap plugin for neovim with no external dependencies
|
||||
|
||||
[[sec-plugins-notifications]]
|
||||
=== Notifications
|
||||
|
||||
* https://github.com/rcarriga/nvim-notify[nvim-notify] simple notification plugin that also integrates with noice.nvim
|
||||
|
||||
[sec-plugins-notes]]
|
||||
=== Note-taking
|
||||
|
||||
* https://github.com/obsidian.nvim[obsidian.nvim] a neovim plugin that deeply integrates with the obsidian markdown editor. Also works standalone
|
||||
* https://github.com/nvim-orgmode/orgmode[orgmode] a neovim replacement for emac orgmode
|
||||
|
||||
[sec-plugins-session-management]]
|
||||
=== Session Management
|
||||
|
||||
* https://github.com/Shatur/neovim-session-manager[neovim-session-manager] a simple wrapper around :mksession
|
||||
|
||||
[sec-plugins-terminal]]
|
||||
=== Terminal
|
||||
|
||||
* https://github.com/akinsho/toggleterm.nvim[toggleterm.nvim] a simple terminal plugin that opens a terminal buffer on demand
|
||||
|
||||
[[sec-plugins-presence]]
|
||||
=== Rich Presence
|
||||
|
||||
* https://github.com/andweeb/presence.nvim[presence.nvim] light and powerful discord rich presence plugin
|
||||
|
||||
[[sec-plugins-utilities]]
|
||||
=== Utilities
|
||||
|
|
@ -53,16 +118,14 @@ The following are the neovim plugins used within neovim-flake. Some plugins are
|
|||
* https://github.com/nvim-telescope/telescope.nvim[telescope] an extendable fuzzy finder of lists. Working ripgrep and fd
|
||||
* https://github.com/folke/which-key.nvim[which-key] a popup that displays possible keybindings of command being typed
|
||||
* https://github.com/sudormrfbin/cheatsheet.nvim[cheatsheet.nvim] a searchable cheatsheet for neovim from within the editor using Telescope
|
||||
* https://github.com/ga-rosa/ccc.nvim[ccc.nvim] super powerful color picker / colorizer plugin.
|
||||
* https://github.com/ziontee113/icon-picker.nvim[icon-picker.nvim] an icon picker plugin that provides access to thousands of icons
|
||||
* https://github.com/jbyuki/venn.nvim[venn.nvim] draw venn diagrams inside neovim
|
||||
|
||||
[[sec-plugins-completions]]
|
||||
=== Completions
|
||||
[[sec-plugins-utilities]]
|
||||
=== Utilities
|
||||
|
||||
* https://github.com/hrsh7th/nvim-cmp[nvim-cmp] a completion engine that utilizes sources
|
||||
** https://github.com/hrsh7th/cmp-buffer[cmp-buffer] a source for buffer words
|
||||
** https://github.com/hrsh7th/cmp-nvim-lsp[cmp-nvim-lsp] a source for builtin LSP client
|
||||
** https://github.com/hrsh7th/cmp-vsnip[cmp-vsnip] a source for vim-vsnip autocomplete
|
||||
** https://github.com/hrsh7th/cmp-path[cmp-path] a source for path autocomplete
|
||||
** https://github.com/ray-x/cmp-treesitter[cmp-treesitter] treesitter nodes autcomplete
|
||||
* https://github.com/folke/noice.nvim[noice.nvim] an experimental neovim plugin that replaces some UI components of neovim
|
||||
|
||||
[[sec-plugins-snippets]]
|
||||
=== Snippets
|
||||
|
|
@ -111,3 +174,7 @@ The following are the neovim plugins used within neovim-flake. Some plugins are
|
|||
=== Dependencies
|
||||
|
||||
* https://github.com/nvim-lua/plenary.nvim[plenary] which is a dependency of some plugins, installed automatically if needed
|
||||
* https://github.comstevearc/dressing.nvim[dressing.nvim] which is a dependency for icon-picker.nvim
|
||||
* https://github.com/preservim/vim-markdown[vim-markdown] which is a dependency for obsidian.nvim
|
||||
* https://github.comgodlygeek/tabular[tabular] which is a dependency for vim-markdown
|
||||
* https://github.com/MunifTanjim/nui.nvim[nui.nvim] which is a dependency for nui-nvim
|
||||
|
|
@ -7,3 +7,4 @@ This section lists the release notes for tagged version of neovim-flake and curr
|
|||
:leveloffset: 1
|
||||
|
||||
include::rl-0.1.adoc[]
|
||||
include::rl-0.2.adoc[]
|
||||
|
|
|
|||
|
|
@ -4,28 +4,43 @@
|
|||
Release notes for release 0.2
|
||||
|
||||
|
||||
[[sec-release-0.1-changelog]]
|
||||
[[sec-release-0.2-changelog]]
|
||||
=== Changelog
|
||||
|
||||
https://github.com/notashelf[notashelf]:
|
||||
|
||||
* Added minimap options under `vim.minimap`. The default will be codewindow.nvim.
|
||||
* Added two minimap plugins under `vim.minimap`. `codewindow.nvim` is enabled by default, while `minimap.vim` is available with its code-minimap dependency.
|
||||
|
||||
* 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.
|
||||
* A complementary plugin, `obsidian.nvim` and the Neovim alternative for Emacs' orgmode with `orgmode.nvim` have been added. Both will be disabled by default.
|
||||
|
||||
* <<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].
|
||||
* Smooth scrolling for ANY movement command is now available with `cinnamon.nvim`
|
||||
|
||||
* `neovimBuilder` has been removed for configuration. Using an overlay is no longer required. See the manual for the new way to configuration.
|
||||
* You will now notice a dashboard on startup. This is provided by the `alpha.nvim` plugin. You can use any of the three available dashboard plugins, or disable them entirely.
|
||||
|
||||
* 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.
|
||||
* There is now a scrollbar on active buffers, which can highlight errors by hooking to your LSPs. This is on by default, but can be toggled off under `vim.visuals` if seen necessary.
|
||||
|
||||
* <<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"
|
||||
----
|
||||
* Discord Rich Presence has been added through `presence.nvim` for those who want to flex that they are using the *superior* text editor.
|
||||
|
||||
* An icon picker is now available with telescope integration. You can use `:IconPickerInsert` or `:IconPickerYank` to add icons to your code.
|
||||
|
||||
* A general purpose cheatsheet has been added through `cheatsheet.nvim`. Forget no longer!
|
||||
|
||||
* `ccc.nvim` has been added to the default plugins to allow picking colors with ease.
|
||||
|
||||
* Most UI components of Neovim have been replaced through the help of `noice.nvim`. There are also notifications and custom UI elements available for Neovim messages and prompts.
|
||||
|
||||
* A (floating by default) terminal has been added through `toggleterm.nvim`.
|
||||
|
||||
* Harness the power of ethical (`tabnine.nvim`) and not-so-ethical (`copilot.lua`) AI by those new assistant plugins. Both are off by default, TabNine needs to be wrapped before it's working.
|
||||
|
||||
* Experimental mouse gestures have been addede through `gesture.nvim`. See plugin page and the relevant module for more details on how to use.
|
||||
|
||||
* Re-open last visited buffers via `nvim-session-manager`. Disabled by default as deleting buffers seems to be problematic at the moment.
|
||||
|
||||
* Most of NvimTree's configuration options have been changed with some options being toggled to off by default.
|
||||
|
||||
* Lualine had its configuration simplified and style toned down. Less color, more info.
|
||||
|
||||
* Modules where multiple plugin configurations were in the same directory have been simplified. Each plugin inside a single module gets its own directory to be imported.
|
||||
|
||||
* Separate config options with the same parent attribute have been merged into one for simplicity.
|
||||
Loading…
Reference in a new issue