feat: add toggleterm, markdown preview keymaps, lualine switch filename and navic (#23)

- Configured toggleterm plugin
- Added keymap for markdown preview
- Changed lualine so Navic is better readable by switching filename and
type with Navic.

README.md

@@ -2,29 +2,63 @@
 
 This repository contains my personal configuration NixVim, a Neovim configuration managed with Nix.
 
-## General Configuration
+![Neovim](./.docs/images/neovim.png)
+
+## How to use
+
+You can use this flake as an input:
+
+```nix
+{
+    inputs = {
+        nixvim.url = "github:dc-tec/nixvim"
+    };
+}
+```
+
+You can then install the package either normally or through home-manager.
+
+#### Normal:
+
+```nix
+environment.systemPackages = [
+    inputs.nixvim.packages.x86_64-linux.default
+];
+```
+
+#### Home-Manager
+
+```nix
+home-manager.users.<user>.home.packages = [
+    inputs.nixvim.packages.x86_64-linux.default
+];
+```
+
+## Plugins
+
+### General Configuration
 
 - `settings.nix`: Contains general settings for Neovim.
 - `keymaps.nix`: Defines key mappings.
 - `auto_cmds.nix`: Sets up automatic commands.
 - `file_types.nix`: Configures file type specific settings.
 
-## Themes
+### Themes
 
 - `default.nix`: Sets the default theme.
 
-## Completion
+### Completion
 
 - `cmp.nix`: Configures the cmp completion framework.
 - `cmp-copilot.nix`: Adds GitHub Copilot support to cmp.
 - `lspkind.nix`: Adds icons to lsp completion items.
 - `autopairs.nix`: Adds the autopairs plugin.
 
-## Snippets
+### Snippets
 
 - `luasnip.nix`: Configures the LuaSnip snippet engine.
 
-## Editor Plugins and Configurations
+### Editor Plugins and Configurations
 
 - `neo-tree.nix`: Configures the NeoTree file explorer.
 - `treesitter.nix`: Configures the TreeSitter syntax highlighter.
@@ -35,24 +69,24 @@ This repository contains my personal configuration NixVim, a Neovim configuratio
 - `copilot-chat.nix`: Configures the Copilot Chat plugin for interacting with GitHub Copilot.
 - `navic.nix`: Configures the Navic plugin, shows the current code context.
 
-## UI Plugins
+### UI Plugins
 
 - `bufferline.nix`: Configures the Bufferline plugin for enhanced buffer/tab display.
 - `lualine.nix`: Configures the Lualine status line plugin.
 - `startup.nix`: Configures the startup screen.
 
-## LSP
+### LSP
 
 - `lsp.nix`: Configures the Neovim LSP client.
 - `conform.nix`: Configures the Conform plugin for automatic code formatting.
 - `fidget.nix`: Configures the Fidget plugin for displaying LSP diagnostics in the status line.
 
-## Git
+### Git
 
 - `lazygit.nix`: Configures the LazyGit plugin for Git integration.
 - `gitsigns.nix`: Configures the GitSigns plugin for displaying Git diff information.
 
-## Utils
+### Utils
 
 - `telescope.nix`: Configures the Telescope plugin for fuzzy finding and picking.
 - `whichkey.nix`: Configures the WhichKey plugin for displaying key mappings.
@@ -60,6 +94,7 @@ This repository contains my personal configuration NixVim, a Neovim configuratio
 - `mini.nix`: Configures the Mini plugin.
 - `obsidian.nix`: Confiugres the Obsidian plugin, for note-taking purposes.
 - `markdown-preview.nix`: Configures the Markdown Preview plugin.
+- `toggleterm.nix`: Configures Terminal plugin.
 
 Please refer to the individual `.nix` files for more detailed configuration information.