mirror of
https://github.com/ryan4yin/nix-config.git
synced 2026-07-15 09:02:40 +02:00
chore(All Markdown Files): auto wrap text, fix typos
This commit is contained in:
Ryan Yin
@@ -6,7 +6,9 @@
|
||||
|
||||
> https://langserver.org/
|
||||
|
||||
The Language Server Protocol (LSP) is an open, JSON-RPC-based protocol for use between source code editors or integrated development environments (IDEs) and servers that provide programming language-specific features like:
|
||||
The Language Server Protocol (LSP) is an open, JSON-RPC-based protocol for use between source code
|
||||
editors or integrated development environments (IDEs) and servers that provide programming
|
||||
language-specific features like:
|
||||
|
||||
- motions such as go-to-definition, find-references, hover.
|
||||
- **code completion**
|
||||
@@ -15,10 +17,11 @@ The Language Server Protocol (LSP) is an open, JSON-RPC-based protocol for use b
|
||||
- syntax highlighting (use Tree-sitter instead)
|
||||
- code formatting (use a dedicated formatter instead)
|
||||
|
||||
The goal of the protocol is to allow programming language support to be implemented and distributed independently of any given editor or IDE.
|
||||
The goal of the protocol is to allow programming language support to be implemented and distributed
|
||||
independently of any given editor or IDE.
|
||||
|
||||
LSP was originally developed for Microsoft Visual Studio Code and is now an open standard.
|
||||
In the early 2020s LSP quickly became a "norm" for language intelligence tools providers.
|
||||
LSP was originally developed for Microsoft Visual Studio Code and is now an open standard. In the
|
||||
early 2020s LSP quickly became a "norm" for language intelligence tools providers.
|
||||
|
||||
### Tree-sitter
|
||||
|
||||
@@ -26,7 +29,9 @@ In the early 2020s LSP quickly became a "norm" for language intelligence tools p
|
||||
|
||||
> https://www.reddit.com/r/neovim/comments/1109wgr/treesitter_vs_lsp_differences_ans_overlap/
|
||||
|
||||
Tree-sitter is a parser generator tool and an **incremental parsing** library. It can build a concrete syntax tree for a source file and efficiently update the syntax tree as the source file is edited.
|
||||
Tree-sitter is a parser generator tool and an **incremental parsing** library. It can build a
|
||||
concrete syntax tree for a source file and efficiently update the syntax tree as the source file is
|
||||
edited.
|
||||
|
||||
It is used by many editors and IDEs to provide:
|
||||
|
||||
@@ -38,17 +43,22 @@ It is used by many editors and IDEs to provide:
|
||||
- such as join/split lines, structural editing, cursor motion, etc.
|
||||
|
||||
**Treesitter process each file independently**, and it is not aware of the semantics of your code.
|
||||
For example, it does not know does a function/variable really exist, or what is the type/return-type of a variable. This is where LSP comes in.
|
||||
For example, it does not know does a function/variable really exist, or what is the type/return-type
|
||||
of a variable. This is where LSP comes in.
|
||||
|
||||
The LSP server parses the code much more deeply and it **not only parses a single file but your whole project**.
|
||||
So, the LSP server will know whether a function/variable does exist with the same type/return-type. If it does not, it will mark it as an error.
|
||||
The LSP server parses the code much more deeply and it **not only parses a single file but your
|
||||
whole project**. So, the LSP server will know whether a function/variable does exist with the same
|
||||
type/return-type. If it does not, it will mark it as an error.
|
||||
|
||||
**LSP does understand the code semantically, while Treesitter only cares about correct syntax**.
|
||||
|
||||
#### LSP vs Tree-sitter
|
||||
|
||||
- Tree-sitter: lightweight, fast, but limited knowledge of your code. mainly used for **syntax highlighting, indentation, and folding/refactoring in a single file**.
|
||||
- LSP: heavy and slow on large projects, but it has a deep understanding of your code. mainly used for **code completion, refactoring in the projects, errors/warnings, and other semantic-aware features**.
|
||||
- Tree-sitter: lightweight, fast, but limited knowledge of your code. mainly used for **syntax
|
||||
highlighting, indentation, and folding/refactoring in a single file**.
|
||||
- LSP: heavy and slow on large projects, but it has a deep understanding of your code. mainly used
|
||||
for **code completion, refactoring in the projects, errors/warnings, and other semantic-aware
|
||||
features**.
|
||||
|
||||
### Formatter vs Linter
|
||||
|
||||
@@ -56,7 +66,10 @@ Linting is distinct from Formatting because:
|
||||
|
||||
1. **formatting** only restructures how code appears.
|
||||
1. `prettier` is a popular formatter.
|
||||
1. **linting** analyzes how the code runs and detects errors, it may also suggest improvements such as replace `var` with `let` or `const`.
|
||||
1. **linting** analyzes how the code runs and detects errors, it may also suggest improvements such
|
||||
as replace `var` with `let` or `const`.
|
||||
|
||||
Formatters and Linters process each file independently, they do not need to know about other files in the project.
|
||||
* [ ]
|
||||
Formatters and Linters process each file independently, they do not need to know about other files
|
||||
in the project.
|
||||
|
||||
- [ ]
|
||||
|
||||
@@ -10,15 +10,18 @@ And `Zellij` for a smooth and stable terminal experience.
|
||||
|
||||
## Tips
|
||||
|
||||
1. Many useful keys are already provided by vim, check vim/neovim's docs before you install a new plugin / reinvent the wheel.
|
||||
1. After using Emacs/Neovim more skillfully, I strongly recommend that you read the official documentation of Neovim/vim:
|
||||
1. Many useful keys are already provided by vim, check vim/neovim's docs before you install a new
|
||||
plugin / reinvent the wheel.
|
||||
1. After using Emacs/Neovim more skillfully, I strongly recommend that you read the official
|
||||
documentation of Neovim/vim:
|
||||
1. <https://vimhelp.org/>: The official vim documentation.
|
||||
1. <https://neovim.io/doc/user/>: Neovim's official user documentation.
|
||||
1. Use Zellij for terminal related operations, and use Neovim/Helix for editing.
|
||||
1. As for Emacs, Use its GUI version & terminal emulator `vterm` for terminal related operations.
|
||||
1. Two powerful file search & jump tools:
|
||||
1. Tree-view plugins are beginner-friendly and intuitive, but they're not very efficient.
|
||||
1. **Search by the file path**: Useful when you're familiar with the project structure, especially on a large project.
|
||||
1. **Search by the file path**: Useful when you're familiar with the project structure, especially
|
||||
on a large project.
|
||||
1. **Search by the content**: Useful when you're familiar with the code.
|
||||
|
||||
## Tutorial
|
||||
@@ -27,13 +30,16 @@ Type `:tutor`(`:Tutor` in Neovim) to learn the basics usage of vim/neovim.
|
||||
|
||||
## VIM's Cheetsheet
|
||||
|
||||
> Here only record my commonly used keys, to see **a more comprehensive cheetsheet**: <https://vimhelp.org/quickref.txt.html>
|
||||
> Here only record my commonly used keys, to see **a more comprehensive cheetsheet**:
|
||||
> <https://vimhelp.org/quickref.txt.html>
|
||||
|
||||
Both Emacs-Evil & Neovim are compatible with vim, sothe key-bindings described here are common in both Emacs-Evil, Neovim & vim.
|
||||
Both Emacs-Evil & Neovim are compatible with vim, sothe key-bindings described here are common in
|
||||
both Emacs-Evil, Neovim & vim.
|
||||
|
||||
### Terminal Related
|
||||
|
||||
I mainly use Zellij for terminal related operations, here is its terminal shortcuts I use frequently now:
|
||||
I mainly use Zellij for terminal related operations, here is its terminal shortcuts I use frequently
|
||||
now:
|
||||
|
||||
| Action | Zellij's Shortcut |
|
||||
| ------------------------- | ----------------- |
|
||||
@@ -76,10 +82,12 @@ I mainly use Zellij for terminal related operations, here is its terminal shortc
|
||||
|
||||
Text Objects:
|
||||
|
||||
- **sentence**: text ending at a '.', '!' or '?' followed by either the end of a line, or by a space or tab.
|
||||
- **sentence**: text ending at a '.', '!' or '?' followed by either the end of a line, or by a space
|
||||
or tab.
|
||||
- **paragraph**: text ending at a blank line.
|
||||
- **section**: text starting with a section header and ending at the start of the next section header (or at the end of the file). - The "`]]`" and "`[[`" commands stop at the '`{`' in the first column. This is
|
||||
useful to find the start of a function in a C/Go/Java/... program.
|
||||
- **section**: text starting with a section header and ending at the start of the next section
|
||||
header (or at the end of the file). - The "`]]`" and "`[[`" commands stop at the '`{`' in the
|
||||
first column. This is useful to find the start of a function in a C/Go/Java/... program.
|
||||
|
||||
### Text Manipulation
|
||||
|
||||
@@ -99,7 +107,7 @@ Basics:
|
||||
| Toggle text's case | `~` |
|
||||
| Convert to uppercase | `U` (visual mode) |
|
||||
| Convert to lowercase | `u` (visual mode) |
|
||||
| Align the selected conent | `:center`/`:left`/`:right` |
|
||||
| Align the selected content | `:center`/`:left`/`:right` |
|
||||
|
||||
Misc:
|
||||
|
||||
@@ -116,7 +124,7 @@ Misc:
|
||||
|
||||
| Action | |
|
||||
| ------------------------------------------------------------------------- | -------------- |
|
||||
| Sort tye selected lines | `:sort` |
|
||||
| Sort the selected lines | `:sort` |
|
||||
| Join Selection of Lines With Space | `:join` or `J` |
|
||||
| Join without spaces | `:join!` |
|
||||
| Enter Insert mode at the start/end of the line | `I` / `A` |
|
||||
@@ -161,7 +169,8 @@ Advance Techs:
|
||||
| Replace all the lines | `:% s/old/new/g` |
|
||||
| Replace all the lines with regex | `:% s@\vhttp://(\w+)@https://\1@gc` |
|
||||
|
||||
1. `\v` means means that in the regex pattern after it can be used without backslash escaping(similar to python's raw string).
|
||||
1. `\v` means means that in the regex pattern after it can be used without backslash
|
||||
escaping(similar to python's raw string).
|
||||
2. `\1` means the first matched group in the pattern.
|
||||
|
||||
### Replace in the specific lines
|
||||
|
||||
@@ -2,23 +2,24 @@
|
||||
|
||||
## S-expression data(Lisp)
|
||||
|
||||
- paredit/[lispy](https://github.com/doomemacs/doomemacs/tree/master/modules/editor/lispy): too complex.
|
||||
- paredit/[lispy](https://github.com/doomemacs/doomemacs/tree/master/modules/editor/lispy): too
|
||||
complex.
|
||||
- [evil-cleverparens](https://github.com/emacs-evil/evil-cleverparens): simple and useful.
|
||||
- [parinfer(par-in-fer)](https://shaunlebron.github.io/parinfer/): morden, simple, elegant and useful, but works not well with some other completion plugins...
|
||||
- to make parinfer works, you should disable sexp & smartparens in any lisp mode.
|
||||
- [parinfer(par-in-fer)](https://shaunlebron.github.io/parinfer/): morden, simple, elegant and
|
||||
useful, but works not well with some other completion plugins...
|
||||
- to make parinfer works, you should disable sexp & smartparens in any lisp mode.
|
||||
|
||||
Some plugins:
|
||||
|
||||
- Emacs
|
||||
- [parinfer-rusT-mode](https://github.com/justinbarclay/parinfer-rust-mode)
|
||||
- [parinfer-rusT-mode](https://github.com/justinbarclay/parinfer-rust-mode)
|
||||
- Neovim
|
||||
- [parinfer-rust](https://github.com/eraserhd/parinfer-rust)
|
||||
- <https://github.com/Olical/conjure>
|
||||
- [parinfer-rust](https://github.com/eraserhd/parinfer-rust)
|
||||
- <https://github.com/Olical/conjure>
|
||||
- Helix
|
||||
- [parinfer #4090 - Helix](https://github.com/helix-editor/helix/discussions/4090)
|
||||
- [parinfer #4090 - Helix](https://github.com/helix-editor/helix/discussions/4090)
|
||||
|
||||
## Other Languages
|
||||
|
||||
1. treesitter
|
||||
1. ...
|
||||
|
||||
|
||||
@@ -6,17 +6,19 @@
|
||||
2. Org Mode
|
||||
3. Lisp Coding
|
||||
4. A top-level tutorial for Emacs(Chinese): <https://nyk.ma/tags/emacs/>
|
||||
5. A Beginner's Guide to Emacs(Chinese): <https://github.com/emacs-tw/emacs-101-beginner-survival-guide>
|
||||
5. A Beginner's Guide to Emacs(Chinese):
|
||||
<https://github.com/emacs-tw/emacs-101-beginner-survival-guide>
|
||||
|
||||
## Screenshot
|
||||
|
||||
|
||||
|
||||
## Usefull Links
|
||||
## Useful Links
|
||||
|
||||
- Framework: <https://github.com/doomemacs/doomemacs>
|
||||
- key bindings:
|
||||
- source code: <https://github.com/doomemacs/doomemacs/blob/master/modules/config/default/%2Bevil-bindings.el>
|
||||
- source code:
|
||||
<https://github.com/doomemacs/doomemacs/blob/master/modules/config/default/%2Bevil-bindings.el>
|
||||
- docs: <https://github.com/doomemacs/doomemacs/blob/master/modules/editor/evil/README.org>
|
||||
- module index: <https://github.com/doomemacs/doomemacs/blob/master/docs/modules.org>
|
||||
- LSP Client: <https://github.com/manateelazycat/lsp-bridge>
|
||||
@@ -44,7 +46,7 @@ when in doubt, run `doom sync`!
|
||||
```bash
|
||||
# testing
|
||||
just emacs-test
|
||||
jsut emacs-purge
|
||||
just emacs-purge
|
||||
just emacs-reload
|
||||
|
||||
# clear test data
|
||||
@@ -59,14 +61,16 @@ just emacs-clean
|
||||
- So vim/neovim is still the best choice for servers.
|
||||
- Emacs's markdown-mode works not well with tables, see:
|
||||
- https://github.com/jrblevin/markdown-mode/issues/380
|
||||
- I use git command frequently, but doomemacs only autoupdates status of git diff / treemacs when using magit.
|
||||
- I use git command frequently, but doomemacs only autoupdates status of git diff / treemacs when
|
||||
using magit.
|
||||
- I have to learn magit to avoid this issue...
|
||||
- GitHub's orgmode support is not well, Markdown is better for GitHub.
|
||||
- Use markdown for repo's README.md, and use orgmode for my personal notes and docs only.
|
||||
|
||||
## Cheetsheet
|
||||
|
||||
Here is the cheetsheet related to my DoomEmacs configs. Please read vim's common cheetsheet at [../README.md](../README.md) before reading the following.
|
||||
Here is the cheetsheet related to my DoomEmacs configs. Please read vim's common cheetsheet at
|
||||
[../README.md](../README.md) before reading the following.
|
||||
|
||||
### Basics
|
||||
|
||||
@@ -98,7 +102,8 @@ Here is the cheetsheet related to my DoomEmacs configs. Please read vim's common
|
||||
### File Tree
|
||||
|
||||
- treemacs: <https://github.com/Alexander-Miller/treemacs/blob/master/src/elisp/treemacs-mode.el>
|
||||
- treemacs-evil: <https://github.com/Alexander-Miller/treemacs/blob/master/src/extra/treemacs-evil.el>
|
||||
- treemacs-evil:
|
||||
<https://github.com/Alexander-Miller/treemacs/blob/master/src/extra/treemacs-evil.el>
|
||||
|
||||
| Action | Shortcut |
|
||||
| ------------------------------------- | --------- |
|
||||
@@ -199,8 +204,9 @@ Magit is a powerful tool that make git operations easy and intuitive.
|
||||
|
||||
Shortcuts in magit's pane:
|
||||
|
||||
> When run `git commit` / `git add` / `git push` /... via magit, multiple Arguments can be set.
|
||||
> Set arguments won't trigger a git command immediately. Magit will try to run a git command only after an Action key is pressed.
|
||||
> When run `git commit` / `git add` / `git push` /... via magit, multiple Arguments can be set. Set
|
||||
> arguments won't trigger a git command immediately. Magit will try to run a git command only after
|
||||
> an Action key is pressed.
|
||||
|
||||
| Action | Shortcut |
|
||||
| -------------------------------------------------- | --------------------------------------------- |
|
||||
@@ -220,4 +226,5 @@ Shortcuts in magit's pane:
|
||||
| Fold/Unfold | `TAB` |
|
||||
| Show details of the current unit(commit/stage/...) | `<ENTER>` |
|
||||
|
||||
KeyBinding full list: <https://github.com/emacs-evil/evil-collection/tree/master/modes/magit#key-bindings>
|
||||
KeyBinding full list:
|
||||
<https://github.com/emacs-evil/evil-collection/tree/master/modes/magit#key-bindings>
|
||||
|
||||
@@ -1,11 +1,14 @@
|
||||
# Helix Editor
|
||||
|
||||
Neovim is really powerful, and have a very active community. I use it as my main editor, and I'm very happy with it. I use it for everything, from writing code to writing this document.
|
||||
Neovim is really powerful, and have a very active community. I use it as my main editor, and I'm
|
||||
very happy with it. I use it for everything, from writing code to writing this document.
|
||||
|
||||
But its configuration is a bit complex, and finding the right plugins, writing configurations, and keeping everything up to date is not easy.
|
||||
But its configuration is a bit complex, and finding the right plugins, writing configurations, and
|
||||
keeping everything up to date is not easy.
|
||||
|
||||
That's why I'm interested in Helix, Helix is similar to Neovim, but it's more opinionated, and it's batteries included.
|
||||
Whether I'll switch my main editor to Helix or not, it gives me a lot of ideas on how to improve my Neovim workflow.
|
||||
That's why I'm interested in Helix, Helix is similar to Neovim, but it's more opinionated, and it's
|
||||
batteries included. Whether I'll switch my main editor to Helix or not, it gives me a lot of ideas
|
||||
on how to improve my Neovim workflow.
|
||||
|
||||
## Tutorial
|
||||
|
||||
@@ -14,30 +17,48 @@ Use `:tutor` in helix to start the tutorial.
|
||||
## Differences between Neovim and Helixer
|
||||
|
||||
1. Selecting first, then action.
|
||||
1. Helix: delete 2 word: `2w` then `x`. You can always see what you're selecting before you apply the action.
|
||||
2. Neovim: delete 2 word: `d`. then `2w`. No visual feedback before you apply the action.
|
||||
1. Helix - Morden builtin features: LSP, tree-sitter, fuzzy finder, multi cursors, surround and more.
|
||||
1. They're all available in Neovim too, but you need to find and use the right plugins manually, which takes time and effort.
|
||||
1. Helix is built in Rust from scratch. The result is a much smaller codebase and a modern set of defaults. No VimScript. No Lua.
|
||||
1. Neovim contains a lot of VimScript, and lua is too dynamic, it's hard to debug.
|
||||
1. Personally I'm glad to take a look at a Rust codebase, but not a VimScript/Lua codebase.
|
||||
1. Neovim have a very activate plugin ecosystem, and it's easy to find plugins for almost everything.
|
||||
1. Helix is still new, and it even do have a stable plugin system yet. A PR to add a plugin system is still envolving: <https://github.com/helix-editor/helix/pull/8675>
|
||||
2. Neovim has intergrated terminal, and it's very powerful. It's quite similar to VSCode's intergrated terminal. I use it a lot.
|
||||
1. Helix doesn't have a intergrated terminal yet, as it's complicated to implement. Users are recommended to use tmux/Zellij or Wezterm/Kitty to implement this feature instead.
|
||||
1. <https://github.com/helix-editor/helix/issues/1976#issuecomment-1091074719>
|
||||
1. <https://github.com/helix-editor/helix/pull/4649>
|
||||
1. **My Neovim often gets stuck when I switch to [toggleterm.nvim](https://github.com/akinsho/toggleterm.nvim), this Helix issue made me consider to switch from this Neovim plugin to Zellij**.
|
||||
1. Helix do not have a tree-view panel, it's recommended to use Yazi/ranger/Broot instead, and open Helix in them.
|
||||
1. a tree-view plugin may be added after the plugin system is stable, but no one knows when it will be.
|
||||
2. and some Helix users stated that they don't need a tree-view plugin, Helix's file picker is useful and good enough.
|
||||
1. It seems Helix lacks a global substitution command, you should run it in another window(via wm or Zellij).
|
||||
1. <https://github.com/helix-editor/helix/issues/196>
|
||||
1. Neovim's substitution command allow you to preview the changes before you apply it, and it's very useful. if I switch to Helix, I'll need to find some other tools with similar feature(such as https://github.com/ms-jpq/sad).
|
||||
1. Complexity and Maintenance Costs vs Batteries Included: <https://github.com/helix-editor/helix/discussions/6356>
|
||||
1. Helix: delete 2 word: `2w` then `x`. You can always see what you're selecting before you apply
|
||||
the action.
|
||||
2. Neovim: delete 2 word: `d`. then `2w`. No visual feedback before you apply the action.
|
||||
1. Helix - Morden builtin features: LSP, tree-sitter, fuzzy finder, multi cursors, surround and
|
||||
more.
|
||||
1. They're all available in Neovim too, but you need to find and use the right plugins manually,
|
||||
which takes time and effort.
|
||||
1. Helix is built in Rust from scratch. The result is a much smaller codebase and a modern set of
|
||||
defaults. No VimScript. No Lua.
|
||||
1. Neovim contains a lot of VimScript, and lua is too dynamic, it's hard to debug.
|
||||
1. Personally I'm glad to take a look at a Rust codebase, but not a VimScript/Lua codebase.
|
||||
1. Neovim have a very activate plugin ecosystem, and it's easy to find plugins for almost
|
||||
everything.
|
||||
1. Helix is still new, and it even do have a stable plugin system yet. A PR to add a plugin
|
||||
system is still envolving: <https://github.com/helix-editor/helix/pull/8675>
|
||||
1. Neovim has integrated terminal, and it's very powerful. It's quite similar to VSCode's integrated
|
||||
terminal. I use it a lot.
|
||||
1. Helix doesn't have a integrated terminal yet, as it's complicated to implement. Users are
|
||||
recommended to use tmux/Zellij or Wezterm/Kitty to implement this feature instead.
|
||||
1. <https://github.com/helix-editor/helix/issues/1976#issuecomment-1091074719>
|
||||
1. <https://github.com/helix-editor/helix/pull/4649>
|
||||
1. **My Neovim often gets stuck when I switch to
|
||||
[toggleterm.nvim](https://github.com/akinsho/toggleterm.nvim), this Helix issue made me
|
||||
consider to switch from this Neovim plugin to Zellij**.
|
||||
1. Helix do not have a tree-view panel, it's recommended to use Yazi/ranger/Broot instead, and open
|
||||
Helix in them.
|
||||
1. a tree-view plugin may be added after the plugin system is stable, but no one knows when it
|
||||
will be.
|
||||
2. and some Helix users stated that they don't need a tree-view plugin, Helix's file picker is
|
||||
useful and good enough.
|
||||
1. It seems Helix lacks a global substitution command, you should run it in another window(via wm or
|
||||
Zellij).
|
||||
1. <https://github.com/helix-editor/helix/issues/196>
|
||||
1. Neovim's substitution command allow you to preview the changes before you apply it, and it's
|
||||
very useful. if I switch to Helix, I'll need to find some other tools with similar
|
||||
feature(such as https://github.com/ms-jpq/sad).
|
||||
1. Complexity and Maintenance Costs vs Batteries Included:
|
||||
<https://github.com/helix-editor/helix/discussions/6356>
|
||||
|
||||
I think Use Helix/Neovim within a terminal file manager(Yazi/ranger/Broot) and Zellij is a good
|
||||
idea. It's quite different from the workflow I migrated from VSCode/JetBrains before, I'm very
|
||||
interested in it.
|
||||
|
||||
I think Use Helix/Neovim within a terminal file manager(Yazi/ranger/Broot) and Zellij is a good idea.
|
||||
It's quite different from the workflow I migrated from VSCode/JetBrains before, I'm very interested in it.
|
||||
|
||||
In Neovim I can make the workflow similar to VSCode/JetBrains by using some plugins, but Helix forces me to get out of my comfort zone, and try something new.
|
||||
In Neovim I can make the workflow similar to VSCode/JetBrains by using some plugins, but Helix
|
||||
forces me to get out of my comfort zone, and try something new.
|
||||
|
||||
@@ -1,14 +1,14 @@
|
||||
# Neovim Editor
|
||||
|
||||
My Neovim config based on [AstroNvim](https://github.com/AstroNvim/AstroNvim).
|
||||
For more details, visit the [AstroNvim website](https://astronvim.com/).
|
||||
My Neovim config based on [AstroNvim](https://github.com/AstroNvim/AstroNvim). For more details,
|
||||
visit the [AstroNvim website](https://astronvim.com/).
|
||||
|
||||
This document outlines neovim's configuration structure and various shortcuts/commands for efficient usage.
|
||||
This document outlines neovim's configuration structure and various shortcuts/commands for efficient
|
||||
usage.
|
||||
|
||||
## Screenshots
|
||||
|
||||
|
||||
|
||||
 
|
||||
|
||||
## Configuration Structure
|
||||
|
||||
@@ -47,7 +47,8 @@ just nvim-clear
|
||||
|
||||
## Cheetsheet
|
||||
|
||||
Here is the cheetsheet related to my Neovim configs. Please read vim's common cheetsheet at [../README.md](../README.md) before reading the following.
|
||||
Here is the cheetsheet related to my Neovim configs. Please read vim's common cheetsheet at
|
||||
[../README.md](../README.md) before reading the following.
|
||||
|
||||
### Incremental Selection
|
||||
|
||||
@@ -62,15 +63,16 @@ Provided by nvim-treesitter.
|
||||
|
||||
### Search and Jump
|
||||
|
||||
Provided by [flash.nvim](https://github.com/folke/flash.nvim), it's a intelligent search and jump plugin.
|
||||
Provided by [flash.nvim](https://github.com/folke/flash.nvim), it's a intelligent search and jump
|
||||
plugin.
|
||||
|
||||
1. It enhaces the default search and jump behavior of neovim.(search with prefix `/`)
|
||||
1. It enhances the default search and jump behavior of neovim.(search with prefix `/`)
|
||||
|
||||
| Action | Shortcut |
|
||||
| ----------------- | ------------------------------------------------------------------------------------------------------------- |
|
||||
| Search | `/`(normal search), `s`(disable all code highlight, only highlight matches) |
|
||||
| Treesitter Search | `yR`,`dR`, `cR`, `vR`, `ctrl+v+R`(arround your matches, all the surrounding Treesitter nodes will be labeled) |
|
||||
| Remote Flash | `yr`, `dr`, `cr`, (arround your matches, all the surrounding Treesitter nodes will be labeled) |
|
||||
| Action | Shortcut |
|
||||
| ----------------- | ------------------------------------------------------------------------------------------------------------ |
|
||||
| Search | `/`(normal search), `s`(disable all code highlight, only highlight matches) |
|
||||
| Treesitter Search | `yR`,`dR`, `cR`, `vR`, `ctrl+v+R`(around your matches, all the surrounding Treesitter nodes will be labeled) |
|
||||
| Remote Flash | `yr`, `dr`, `cr`, (around your matches, all the surrounding Treesitter nodes will be labeled) |
|
||||
|
||||
### Commands & Shortcuts
|
||||
|
||||
@@ -92,12 +94,8 @@ Provided by [flash.nvim](https://github.com/folke/flash.nvim), it's a intelligen
|
||||
|
||||
### Splitting and Buffers
|
||||
|
||||
|
|
||||
| Action | Shortcut |
|
||||
| --------------------- | ------------- |
|
||||
| Horizontal Split | `\` |
|
||||
| Vertical Split | `\|` |
|
||||
| Close Buffer | `<Space> + c` |
|
||||
| | Action | Shortcut | | --------------------- | ------------- | | Horizontal Split | `\` | |
|
||||
Vertical Split | `\|` | | Close Buffer | `<Space> + c` |
|
||||
|
||||
### Editing and Formatting
|
||||
|
||||
@@ -129,9 +127,9 @@ Press `<Space> + D` to view available bindings and options.
|
||||
|
||||
### Search and Replace Globally
|
||||
|
||||
| Description | Shortcut |
|
||||
| ------------------------------------------------------------ | ---------------------------------------------------------------- |
|
||||
| Open spectre.nvim search and replace panel | `<Space> + ss` |
|
||||
| Description | Shortcut |
|
||||
| ------------------------------------------ | -------------- |
|
||||
| Open spectre.nvim search and replace panel | `<Space> + ss` |
|
||||
|
||||
Search and replace via cli(fd + sad + delta):
|
||||
|
||||
@@ -139,7 +137,6 @@ Search and replace via cli(fd + sad + delta):
|
||||
fd "\\.nix$" . | sad '<pattern>' '<replacement>' | delta
|
||||
```
|
||||
|
||||
|
||||
### Surrounding Characters
|
||||
|
||||
Provided by mini.surround plugin.
|
||||
|
||||
Reference in New Issue
Block a user