Started base documentation

2021-08-12 02:55:57 +00:00 · 2021-08-12 02:55:57 +00:00 · abe7917b11
parent 672ef634ee
commit abe7917b11
1 changed files with 40 additions and 0 deletions
--- a/doc/config.txt
+++ b/doc/config.txt
@ -0,0 +1,40 @@
+==============================================================================
+1. custom config                                               *custom-config*
+
+An extensible and modular configuration of [Neovim](https://neovim.io).
+This repository is to provide sensible defaults that can be further modified to
+the user's liking. Customize and extend at your own disgression.
+
+==============================================================================
+2. overview                                           *cvoges-config-overview*
+
+This config contains:
+ LSP configuration
+    * errors, warnings, info, hints
+    * extendable keybindings for
+        - locate definition
+        - rename
+        - formatting
+        - locate type definition
+        - locate references
+        - apply edit
+        - completion
+        - code actions
+        - hover menu
+        - document symbols
+
+ small plug-in manaegr
+ asynchronous configuration loading
+ modular status bar w/ by default:
+    * lsp module
+    * file path module
+    * file type module
+    * file percentage module
+    * columns,line number module
+    * ReadOnly or Modified flag module
+
+ support for multiple keyboard layouts
+ benchmark script
+
+This config does **NOT** contain:
+- language servers