feat(readme): clean up config readme

lua/cosmic/config/examples/config.lua

@@ -6,39 +6,31 @@
 local config = {
   -- See https://github.com/rmagatti/auto-session#%EF%B8%8F-configuration
   auto_session = {},
-
   -- See :h nvim_open_win for possible border options
   border = 'rounded',
-
   -- https://github.com/numToStr/Comment.nvim#configuration-optional
   comment_nvim = {},
-
   -- See https://github.com/CosmicNvim/cosmic-ui#%EF%B8%8F-configuration
   cosmic_ui = {},
-
-  -- see :h vim.diagnostic.config for all diagnostic configuration options
+  -- See :h vim.diagnostic.config for all diagnostic configuration options
   diagnostic = {},
-
-  -- see :h gitsigns-usage
+  -- See :h gitsigns-usage
   gitsigns = {},
-
-  -- lsp settings
+  -- LSP settings
   lsp = {
-
-    -- true/false or table of filetypes {'.ts', '.js',}
+    -- True/false or table of filetypes {'.ts', '.js',}
     format_on_save = true,
-
-    -- set to false to disable rename notification
+    -- Set to false to disable rename notification
     rename_notification = true,
-
+    -- Enable non-default servers, use default lsp config
+    -- Check here for configs that will be used by default: https://github.com/williamboman/nvim-lsp-installer/tree/main/lua/nvim-lsp-installer/servers
     servers = {
+      -- Enable rust_analyzer
+      rust_analyzer = true,
 
-      -- enable non-default servers, use default lsp config
-      -- check here for configs that will be used by default: https://github.com/williamboman/nvim-lsp-installer/tree/main/lua/nvim-lsp-installer/servers
-      -- rust_analyzer = true,
-
+      -- Enable tsserver w/custom settings
       tsserver = {
-        -- disable formatting (defaults to true)
+        -- Disable formatting (defaults to true)
         format = false,
         -- OR add/override server options
         opts = {
@@ -48,64 +40,42 @@ local config = {
           },
         },
       },
-
-      -- See Cosmic defaults lsp/providers/null_ls.lua
-      -- and https://github.com/jose-elias-alvarez/null-ls.nvim/
+      -- See Cosmic defaults lsp/providers/null_ls.lua and https://github.com/jose-elias-alvarez/null-ls.nvim/
       -- If adding additional sources, be sure to also copy the defaults that you would like to preserve from lsp/providers/null_ls.lua
       null_ls = {
-        -- disable default list of sources provided by CosmicNvim
+        -- Disable default list of sources provided by CosmicNvim
         default_cosmic_sources = false,
-        -- add additional sources here
+        -- Add additional sources here
         sources = {},
       },
     },
-
     -- See Cosmic defaults lsp/providers/tsserver.lua
     ts_utils = {},
   },
-
   -- See https://github.com/ray-x/lsp_signature.nvim#full-configuration-with-default-values
   lsp_signature = {},
-
   -- See https://github.com/L3MON4D3/LuaSnip/blob/577045e9adf325e58f690f4d4b4a293f3dcec1b3/README.md#config
   luasnip = {},
-
-  -- default statusline icon
+  -- Default statusline icon
   statusline = {
     main_icon = '★',
   },
-
   -- See :h telescope.setup
   telescope = {},
-
-  -- theming, don't forget to run :CosmicReloadSync when changing themes
-  -- 'catppuccin',
-  -- 'dracula',
-  -- 'enfocado',
-  -- 'github',
-  -- 'gruvbox',
-  -- 'kanagawa',
-  -- 'nightfox',
-  -- 'nord',
-  -- 'onedark',
-  -- 'rose-pine',
+  -- Theming, don't forget to run :CosmicReloadSync when changing themes
+  -- Options: 'catppuccin', 'dracula', 'enfocado', 'github', 'gruvbox', 'kanagawa', 'nightfox', 'nord', 'onedark', 'rose-pine',
   theme = 'tokyonight', -- don't define or set to nil, if you want to enable your own theme in cosmic/config/plugins.lua
-
   -- See https://github.com/folke/todo-comments.nvim#%EF%B8%8F-configuration
   todo_comments = {},
-
   -- See :h nvim-treesitter-quickstart
   treesitter = {},
-
   -- See :h notify.setup
   notify = {},
-  --
   -- See :h cmp-usage
   nvim_cmp = {},
-
   -- See :h nvim-tree.setup
   nvim_tree = {},
-
+  -- Add additional plugins
   add_plugins = {
     'ggandor/lightspeed.nvim',
     {
@@ -113,7 +83,7 @@ local config = {
       requires = { 'kyazdani42/nvim-web-devicons' },
     },
   },
-
+  -- Disable plugins enabled by CosmicNvim
   disable_builtin_plugins = {
     --[[
     'auto-session',