From 1b4a6e5a5ba413daea6d74a4ac2f9d8af74b0fc2 Mon Sep 17 00:00:00 2001 From: NTBBloodbath Date: Fri, 30 Apr 2021 00:28:11 -0400 Subject: [PATCH] docs: update docs, big improvements to CHANGELOG --- doc/doom_nvim.txt | 274 ++++++++++++++++++++++++++++------------------ 1 file changed, 166 insertions(+), 108 deletions(-) diff --git a/doc/doom_nvim.txt b/doc/doom_nvim.txt index f384f18..cd643da 100644 --- a/doc/doom_nvim.txt +++ b/doc/doom_nvim.txt @@ -42,17 +42,16 @@ 9. LSP......................................|doom_nvim_configuration_lsp| 4. Commands............................................|doom_nvim_commands| 1. Keybindings...........................|doom_nvim_commands_keybindings| - 5. Functions..........................................|doom_nvim_functions| - 6. Usage..................................................|doom_nvim_usage| + 5. Usage..................................................|doom_nvim_usage| 1. Moving around..........................|doom_nvim_usage_moving_around| - 7. Known issues..........................................|doom_nvim_issues| - 8. FAQ......................................................|doom_nvim_faq| - 9. Hacking Doom Nvim....................................|doom_nvim_hacking| + 6. Known issues..........................................|doom_nvim_issues| + 7. FAQ......................................................|doom_nvim_faq| + 8. Hacking Doom Nvim....................................|doom_nvim_hacking| 1. Autoload..................................|doom_nvim_hacking_autoload| - 10. Acknowledgements...........................|doom_nvim_acknowledgements| - 11. License.............................................|doom_nvim_license| - 12. Contributing...................................|doom_nvim_contributing| - 13. Changelog.........................................|doom_nvim_changelog| + 9. Acknowledgements...........................|doom_nvim_acknowledgements| + 10. License.............................................|doom_nvim_license| + 11. Contributing...................................|doom_nvim_contributing| + 12. Changelog.........................................|doom_nvim_changelog| ============================================================================== @@ -96,6 +95,12 @@ default value = 0 default value = 0 0 : Disable session autosave 1 : Enable session autosave +This option will also autoload saved sessions + +`g:doom_autoload_last_session` +default value = 0 +0 : Disable autoload of last unsaved session +1 : Enable autoload of last unsaved session `g:doom_preserve_edit_pos` default value = 1 @@ -190,7 +195,7 @@ Set the Terminal height Applies to all directions except window `g:doom_conceallevel` -default value = 1 +default value = 0 Set Neovim conceal level 0 : Disable indentline and show all 1 : Conceal some functions and show indentlines @@ -270,7 +275,7 @@ following layout: -'A' : The tagbar (Plugin: vista.vim) +'A' : The tagbar (Plugin: SymbolsOutline) 'B' : The main buffer 'C' : The terminal (Plugin: nvim-toggleterm.lua) 'D' : The minimap (Plugin: minimap.vim) @@ -310,11 +315,13 @@ TAGBAR *doom_nvim_configuration_layout_tagbar* Tagbar is a plugin that can show the tags and structure of the opened file, ordered by its scope. For this function, Doom Nvim makes use of -`liuchengxu/vista.vim`. It can be toggled by performing the following commands: -tT for `Tagbar` +`simrat39/symbols-outline.nvim`. It can be toggled by performing the following +commands: + +tS for `Tagbar` for `Tagbar` -See https://github.com/liuchengxu/vista.vim for more information. +See https://github.com/simrat39/symbols-outline.nvim for more information. ============================================================================== @@ -333,6 +340,7 @@ The terminal is placed like in others editors, e.g. Visual Studio Code. The buffer of the terminal is automatically set to `INSERT` mode. The only way to close it is to enter `exit` to close the shell session, or if you just want to toggle it, you can enter in `NORMAL` mode: + tt for `Terminal` for `Terminal` @@ -345,12 +353,12 @@ bundle of plugins, configuration and commands, organized into a unit that can be toggled easily. To give a quick summary, the modules are as follows: - - Essentials (package manager, utilities for using Lua inside Neovim) + - Essentials (package manager, TreeSitter and utilities for using + Lua inside Neovim) - UI (everything related to UI) - - Fuzzy (telescope.nvim, fuzzy searching) - Git (everything related to Git) - LSP (for using Language Server Protocols by using the built-in LSP) - - Files (utilities like formatter, commenter, improvements, etc) + - Files (utilities like formatter, commenter, etc) - Web (for web development) You can see in a more detailed view the modules and its plugins at @@ -365,7 +373,7 @@ To enable a module, you can use the `g:doom_disabled_modules` variable on your Example: To enable all modules except web, just put only 'web' in the disabled - modules array and then, reboot Neovim and do `:PackerSync`. + modules array and then reboot Neovim and do `:PackerSync`. let g:doom_disabled_modules = ['web'] @@ -378,7 +386,7 @@ your `doomrc`. Example: To disable only the web module, just put only 'web' in the disabled - modules array and then, reboot Neovim and do `:PackerSync`. + modules array and then reboot Neovim and do `:PackerSync`. let g:doom_disabled_modules = ['web'] @@ -478,26 +486,33 @@ In Doom Nvim, we make use of the keystroke as the map leader. | oom | | Edit your Doom Nvim configuration | | Open Doom Nvim docs +| | Create crash reports, useful for debugging | | Check Doom Nvim updates | ile | | Bookmarks | | Edit your Neovim Configuration | | Find file -| | Find word +| | Find word | | Recently opened files | | New unnamed buffer | | Re-open an unreadable file with sudo permissions | | Help tags | | Write an unwritable file with sudo permissions | it +| | Blame line +| | Preview hunk +| | Reset buffer +| | Reset hunk | | Open LazyGit -| |

Push | |

Pull +| |

Push +| | Stage hunk | | Status +| | Undo stage hunk | sp -| | Show type definition -| | Show line diagnostics -| | Diagnostics into location list +| | Show type definition +| | Show line diagnostics +| | Diagnostics into location list | rder | | Sort by directory | | Sort by language @@ -506,21 +521,22 @@ In Doom Nvim, we make use of the keystroke as the map leader. |

lugin | | Clean unused plugins | | Install missing plugins +| |

Profile the time taken loading your plugins | | Sync plugins (Clean and Update) | | Update plugins | unner -| | Run rest client in the current cursor line +| | Run restclient in the current cursor line | ession -| | Save session -| | Load session +| | Session switcher/selector +| | Save current session +| | Restore previously saved session | oggler | | Change colorscheme | | Toggle Tree Explorer | | Toggle Minimap -| | Toggle Line Numbers +| | Toggle Symbols view | | Toggle Start Screen | | Toggle Terminal -| | Toggle Tagbar | indow | | Close current window | | Close all other windows @@ -538,9 +554,9 @@ your life easier! | | Toggle Tree Explorer | | Toggle Terminal | | Toggle Minimap -| | Toggle distraction-free mode -| | Run rest client -| | Fast exit from Doom Nvim +| | ToggleZen mode +| | Run restclient +| | Fast exit from Doom Nvim (also dumps `:messages` to logs) | | Comment selected block (`VISUAL` mode) You can modify the default keybindings by modifying the following files: @@ -551,14 +567,6 @@ You can modify the default keybindings by modifying the following files: You can also make your own keybindings by editing your `doomrc` file. -============================================================================== -FUNCTIONS *doom_nvim_functions* - -`ToggleNumbers`: Toggles the line numbers, if `g:doom_relative_num` is `1` -then it will toggle the relative numbers, otherwise, it will toggle the -absolute numbers. - - ============================================================================== USAGE *doom_nvim_usage* @@ -584,19 +592,16 @@ Use `h` go to left, `j` to go down, `k` to go up, `l` to go right. j v -See `Tutor` to know how to use Vim and its keybindings +See `Tutor` to know how to use Vim and its keybindings. To move around buffers execute b to select the `buffers` section -and then press the key corresponding to the buffer you want to select (`1-9`). +and then press the key corresponding to the buffer you want to select (`1-9`) +or press `` to cycle buffers. ============================================================================== KNOWN ISSUES *doom_nvim_issues* -- When using the distraction-free mode, it will be still displaying the - statusbar, at the moment cannot be fixed unless you use other statusline. - See |doom_nvim_configuration_modules_disabling| for more information. - - If you are facing an undocummented issue, feel free to open an issue at Doom Nvim's repository on GitHub and we will try to fix it. https://github.com/NTBBloodbath/doom-nvim/issues/new @@ -627,40 +632,40 @@ Doom Nvim aims to be hackable to suit everyone's needs. Therefore This is the structure of Doom Nvim: - ./ -├──  autoload/ # Files loaded at launch -│ ├──  color.vim # Color utilities, required by doom-one.vim -│ ├──  doom/ # Doom Nvim core -│ │ ├──  autocmds.vim # Doom Nvim autocommands -│ │ ├──  config.vim # Doom Nvim custom config file loader -│ │ ├──  default.vim # Doom Nvim default configs -│ │ ├──  functions.vim # Doom Nvim core functions -│ │ ├──  health.vim # Doom Nvim health -│ │ ├──  logging.vim # Doom Nvim logging manager -│ │ └──  system.vim # Doom Nvim system detection (early stage) -│ └──  doom.vim # Config file for various globals -├──  colors/ # Doom Nvim colorschemes directory -│ └──  doom-one.vim # `romgrk` doom colorscheme ported to Nvim (`default`) -├──  config/ # Configuration files for Doom Nvim -│ ├──  gui.vim # Doom Nvim GUI options -│ ├──  keybindings.vim # Doom Nvim keybindings -│ ├──  main.vim # Init file, loads packer.nvim and plugins -│ └──  plugins/ # Vimscript plugins configs directory -│ ├──  leader....vim # leader-mapper keybindings -│ ├──  neoformat.vim # neoformat configs -│ └──  vista.vim # vista.vim configs -├──  doc/ # Doom Nvim documentation to be used inside Nvim -│ └──  doom_nvim.txt # Doom Nvim help file -├──  docs/ # Doom Nvim docs meant to be readed on GitHub -├──  init.vim # init.vim file -├──  install.sh # Doom Nvim manager -├──  LICENSE # Doom Nvim License -├──  logs/ # Location of Doom Nvim log file -├──  lua/ # Location of Lua plugins, including packer.nvim -│ ├──  configs/ # Location of Lua plugins configurations -│ └──  plugins.lua # Plugin manager configurations -└──  sessions/ # Location of Vim workspaces - + . +├──  autoload # Files loaded at launch +│ ├──  color.vim # Color utilities, required by `doom-one.vim` +│ ├──  doom # Doom Nvim core +│ │ ├──  autocmds.vim # Doom Nvim autocommands +│ │ ├──  config.vim # Doom Nvim custom config file loader +│ │ ├──  default.vim # Doom Nvim default configs +│ │ ├──  functions.vim # Doom Nvim core functions +│ │ ├──  logging.vim # Doom Nvim logging manager +│ │ └──  system.vim # Doom Nvim system detection (early stage) +│ ├──  doom.vim # Config file for various globals +│ └──  health # Doom Nvim health add-ons for `:checkhealth` +├──  colors # Doom Nvim pre-installed colorschemes directory +│ └──  doom-one.vim # `romgrk` doom colorscheme ported to Nvim (`default`) +├──  doc # Doom Nvim documentation to be used inside Nvim +│ └──  doom_nvim.txt # Doom Nvim help file +├──  docs # Doom Nvim docs meant to be readed on GitHub +├──  doomrc # Doom Nvim user configurations file +├──  init.lua # init.lua file +├──  install.sh # Doom Nvim installer +├──  LICENSE # Doom Nvim License +├──  logs # Location of Doom Nvim logs +│ ├──  doom.log # Doom Nvim logs +│ └──  report.md # Doom Nvim crash reports, does not exists by default +├──  lua # Location of Doom Nvim Lua files +│ ├──  doom # Doom Nvim Lua core +│ │ ├──  config # Main configurations of Doom Nvim +│ │ ├──  health.lua # Doom Nvim health checking, complement for health dir +│ │ ├──  keybindings.lua # Doom Nvim default keybindings +│ │ └──  utils # Doom Nvim Lua utilities +│ └──  plugins # Location of Doom Nvim plugins +│ ├──  configs # Plugins configurations +│ └──  init.lua # packer.nvim setup +└──  sessions # Location of Neovim workspaces Doom Nvim also creates the `BFC`, which serves as the user configuration file if it is not present on the system. It allows a fine control over the core @@ -733,35 +738,88 @@ CONTRIBUTING *doom_nvim_contributing* ============================================================================== CHANGELOG *doom_nvim_changelog* -Doom Nvim follows the semantic versioning and reached its stable version in -version 1.0.0 - +The format is based on Keep a Changelog (https://keepachangelog.com/en/1.0.0/), +and this project adheres to Semantic Versioning +(https://semver.org/spec/v2.0.0.html). + +- 2.0.0 (in development) + - Added + - Configurations + - `g:doom_autoload_last_session` variable, see |doom_nvim_options| + - `g:doom_terminal_direction` variable, see |doom_nvim_options| + - `g:doom_terminal_width` variable, see |doom_nvim_options| + - `g:doom_terminal_height` variable, see |doom_nvim_options| + - Plugins + - `auto-session` + - Changed + - Installation script + - Now you can select the branch to use (main, develop) + - Lua migration + - init + - configs + - plugins + - Implemented better custom plugins system, + see |doom_nvim_configuration_custom_plugins| + - Start using TreeSitter based indentation + - Plugins + - Replaced + - `Goyo` in favour of `TrueZen` + - `leader-mapper` in favour of `WhichKey` + - `Vista.vim` in favour of `SymbolsOutline` + - `Neoformat` in favour of `format.nvim` + - `nvim-autopairs` in favour of `pears.nvim` + - Updated + - `nvim-toggleterm` configurations + - Other changes + - `telescope.nvim` cannot be disabled anymore + - Keybindings + - Refact some `` bindings + - Use `:TZAtaraxis` as F6 key bind + - New `:dr` map, easily create crash reports + - Misc + - Cleaned some code hunk + - Formatted all files + - Refact changelog + - Deleted + - Old Vimscript configs codebase + - Plugins + - Deleted `vim-polyglot` in favour of TreeSitter based + syntax highlighting + - Fixed + - Some bugs that I don't really remember + - Squashed bugs on autoload functions - 1.2.1 - - Improved installation script - - New branch `develop` + - Added + - New branch `develop` + - Changed + - Improved installation script - 1.2.0 - - Added `g:doom_ts_parsers`, - see |doom_nvim_options| - - Added new keybinding for toggle terminal, - see |doom_nvim_commands_keybindings| - - Added a basic implementation for `:checkhealth` command - - Added a `doomrc` template with the default options values - - Improved `:DoomUpdate` command - - Added new plugins - - `gitsigns` - - `indentLine` - - `nvim-lspinstall` - - some new colorschemes, see |doom_colorscheme| - - Removed plugins - - `signify` in favor of `gitsigns` - - Squashed some bugs - - Some minor changes more under the hood + - Added + - Configurations + - `g:doom_ts_parsers`, see |doom_nvim_options| + - New key binding for toggle terminal, + see |doom_nvim_commands_keybindings| + - `doomrc` template with the default options values + - Basic implementation for `:checkhealth` command + - Plugins + - `gitsigns` + - `indentLine` + - `nvim-lspinstall` + - Some new colorschemes, see |doom_colorscheme| + - Changed + - Improved `:DoomUpdate` command + - Some minor changes more under the hood + - Plugins + - `signify` in favor of `gitsigns` + - Fixed + - Squashed some bugs - 1.1.0 - - Added `Doom` section to `vim-leader-guide` plugin, - see |doom_nvim_commands_keybindings| - - Added `:DoomUpdate` command, - see |doom_nvim_commands| - - Added `g:doom_autosave_sessions`, - see |doom_nvim_options| + - Added + - `Doom` section to `vim-leader-guide` plugin, + see |doom_nvim_commands_keybindings| + - `:DoomUpdate` command, + see |doom_nvim_commands| + - `g:doom_autosave_sessions`, + see |doom_nvim_options| - 1.0.0 - - Initial stable release + - Initial stable release