From e309364377a6b4c28f6f813fb16be31e10dbc4ee Mon Sep 17 00:00:00 2001 From: rebuilt Date: Tue, 6 Jul 2021 01:25:35 +0200 Subject: [PATCH] Modified plugin section to describe installing plugins. --- Home.md | 72 +++++++++++++++++++++++++-------------------------------- 1 file changed, 31 insertions(+), 41 deletions(-) diff --git a/Home.md b/Home.md index cdb91be..e34fe62 100644 --- a/Home.md +++ b/Home.md @@ -13,6 +13,8 @@ * [Leader and Whichkey](#leader-and-whichkey) * [Important Configuration files](#important-configuration-files) - [Install your own plugins](#install-your-own-plugins) + * [Built-in plugins](#built-in-plugins) + * [User-defined plugins](#user-defined-plugins) * [Removing plugins](#removing-plugins) * [Finding plugins](#finding-plugins) - [Using Packer](#using-packer) @@ -255,55 +257,43 @@ vim.cmd([[ # Install your own plugins -Most plugins are disabled by default. If you wish to enable a plugin, turn it on by setting the plugin to 'active' and installing it with packer. - -For example, to enable hop add the following line to your personal configuration file - +## Built-in plugins +LunarVim comes bundled with a small set of default plugins. To enable a plugin, add an entry for it in your personal configuration file. ``` -- ~/.config/nvim/lv-config.lua -O.plugin.hop.active = true +O.plugin.dashboard.active = true ``` -The following is a list of available plugins. Some plugins may require you to set your own keybindings. Check the github project page for each plugin to learn exactly what configuration options are available. This list will grow as we add more plugins. Check default-config.lua or plugins.lua to see if others have been added. +The following is a list of available plugins. Some plugins may require you to set your own keybindings. Check the github project page for each plugin to learn exactly what configuration options are available. The built-in plugins are defined in ~/.config/nvim/lua/default-config.lua ``` -hop -dial -dashboard -matchup -colorizer -numb -zen -ts_playground -indent_line -ts_context_commentstring -symbol_outline -debug -bqf -trouble -floatterm -spectre -lsp_rooter -markdown_preview -codi -telescope_fzy -sanegx -snap -ranger -todo_comments -lsp_colors -git_blame -gist -gitlinker -lazygit -octo -lush -diffview -bracey -telescope_project -dap_install + dashboard = { active = false }, + colorizer = { active = false }, + zen = { active = false }, + ts_playground = { active = false }, + ts_context_commentstring = { active = false }, + telescope_fzy = { active = false }, + telescope_project = { active = false }, + indent_line = { active = false }, + symbol_outline = { active = false }, + debug = { active = false }, + dap_install = { active = false }, + lazygit = { active = false }, + lush = { active = false }, + diffview = { active = false }, ``` + +## User-defined plugins + +If you'd like to install plugins that aren't bundled with LunarVim, define them in your personal configuration file. Any plugins you want to use should be defined in lv-config.lua using the custom_plugins table. + +``` +# lv-config.lua +# Other, user-defined plugins will be another entry in this table +O.custom_plugins = {{"folke/tokyonight.nvim"}} +``` + ## Removing plugins To disable a plugin set it's active state to 'false'.