From d4f30b8865eddbad4604a07110878aff3d715823 Mon Sep 17 00:00:00 2001 From: Eric Wong Date: Tue, 18 Jun 2024 21:47:05 +0800 Subject: [PATCH] docs(help): update doc --- autoload/SpaceVim.vim | 20 +++++++++++++++++--- autoload/SpaceVim/logger.vim | 9 +++++++++ doc/SpaceVim.txt | 35 +++++++++++++++++++++++++++++++---- 3 files changed, 57 insertions(+), 7 deletions(-) diff --git a/autoload/SpaceVim.vim b/autoload/SpaceVim.vim index 67ccdb3c0..cba82c122 100644 --- a/autoload/SpaceVim.vim +++ b/autoload/SpaceVim.vim @@ -12,9 +12,23 @@ scriptencoding utf-8 " @stylized spacevim " @library " @order intro options config functions layers usage plugins api dev community faq roadmap changelog -" SpaceVim is a bundle of custom settings and plugins with a modular -" configuration for Vim. It was inspired by Spacemacs. -" +" SpaceVim is a modular configuration of Vim and Neovim. +" It's inspired by spacemacs. It manages collections of plugins in layers, +" which help to collect related packages together to provide features. +" This approach helps keep the configuration organized and reduces +" overhead for the user by keeping them from having to think about +" what packages to install. + +"" +" @section Highlighted Features, features +" @parentsection intro +" 1. Modularization: Plugins are organized in @section(layers). +" 2. Compatible API: A series of @section(api) for Vim/Neovim. +" 3. Great documentation: Everything is documented in `:h SpaceVim`. +" 4. Better experience: Most of the core plugins have been rewritten using Lua. +" 5. Beautiful UI: The interface has been carefully designed. +" 6. Mnemonic key bindings: Key bindings are organized using mnemonic prefixes. +" 7. Lower the risk of RSI: Heavily using the `` key instead of modifiers. "" " @section Options, options diff --git a/autoload/SpaceVim/logger.vim b/autoload/SpaceVim/logger.vim index c251de090..137f2e051 100644 --- a/autoload/SpaceVim/logger.vim +++ b/autoload/SpaceVim/logger.vim @@ -6,6 +6,15 @@ " License: GPLv3 "============================================================================= +"" +" @section Runtime Log, runtime-log +" @parentsection dev +" The runtime log of SpaceVim can be obtained via the key binding `SPC h L`. +" To get the debug information about the current SpaceVim environment, +" Use the command `:SPDebugInfo!`. This command will open a new buffer where default information will be shown. +" You can also use `SPC h I` to open a buffer with SpaceVim's issue template. + + if has('nvim-0.5.0') "" " write message to SpaceVim runtime log with `info` level. diff --git a/doc/SpaceVim.txt b/doc/SpaceVim.txt index b00b5b5e8..5f85b6b3f 100644 --- a/doc/SpaceVim.txt +++ b/doc/SpaceVim.txt @@ -17,6 +17,7 @@ wsdjeg *spacevim* *SpaceVim* ============================================================================== CONTENTS *SpaceVim-contents* 1. Introduction.............................................. |SpaceVim-intro| + 1. Highlighted Features............................... |SpaceVim-features| 2. Options................................................. |SpaceVim-options| 1. autocomplete_method............. |SpaceVim-options-autocomplete_method| 2. autocomplete_parens............. |SpaceVim-options-autocomplete_parens| @@ -289,8 +290,9 @@ CONTENTS *SpaceVim-contents* 21. vim#window.................................. |SpaceVim-api-vim-window| 10. Development................................................ |SpaceVim-dev| 1. License......................................... |SpaceVim-dev-license| - 2. commit-style-guide................... |SpaceVim-dev-commit-style-guide| - 3. merge requese............................. |SpaceVim-dev-merge-request| + 2. Runtime Log..................................... |SpaceVim-runtime-log| + 3. commit-style-guide................... |SpaceVim-dev-commit-style-guide| + 4. merge requese............................. |SpaceVim-dev-merge-request| 11. Community............................................ |SpaceVim-community| 12. FAQ........................................................ |SpaceVim-faq| 13. Roadmap................................................ |SpaceVim-roadmap| @@ -299,9 +301,25 @@ CONTENTS *SpaceVim-contents* ============================================================================== INTRODUCTION *SpaceVim-intro* -SpaceVim is a bundle of custom settings and plugins with a modular -configuration for Vim. It was inspired by Spacemacs. +SpaceVim is a modular configuration of Vim and Neovim. It's inspired by +spacemacs. It manages collections of plugins in layers, which help to collect +related packages together to provide features. This approach helps keep the +configuration organized and reduces overhead for the user by keeping them from +having to think about what packages to install. +============================================================================== +HIGHLIGHTED FEATURES *SpaceVim-features* + + 1. Modularization: Plugins are organized in |SpaceVim-layers|. + 2. Compatible API: A series of |SpaceVim-api| for Vim/Neovim. + 3. Great documentation: Everything is documented in `:h SpaceVim`. + 4. Better experience: Most of the core plugins have been rewritten using + Lua. + 5. Beautiful UI: The interface has been carefully designed. + 6. Mnemonic key bindings: Key bindings are organized using mnemonic + prefixes. + 7. Lower the risk of RSI: Heavily using the `` key instead of + modifiers. ============================================================================== OPTIONS *SpaceVim-options* @@ -7097,6 +7115,15 @@ For files not belonging to SpaceVim like bundle packages, refer to the header file. Those files should not have an empty header, we may not accept code without a proper header file. +============================================================================== +RUNTIME LOG *SpaceVim-runtime-log* + +The runtime log of SpaceVim can be obtained via the key binding `SPC h L`. To +get the debug information about the current SpaceVim environment, Use the +command `:SPDebugInfo!`. This command will open a new buffer where default +information will be shown. You can also use `SPC h I` to open a buffer with +SpaceVim's issue template. + ============================================================================== COMMIT-STYLE-GUIDE *SpaceVim-dev-commit-style-guide*