From 5ed096bc4762f1cfe88af92aaf4528ccc6a97170 Mon Sep 17 00:00:00 2001 From: Micah Halter Date: Fri, 10 Nov 2023 11:28:11 -0500 Subject: [PATCH] feat: add description to mappings page --- astro.config.mjs | 8 +- src/content/docs/basic-usage/walkthrough.md | 95 ------------------- .../docs/{basic-usage => }/mappings.md | 10 +- 3 files changed, 7 insertions(+), 106 deletions(-) delete mode 100644 src/content/docs/basic-usage/walkthrough.md rename src/content/docs/{basic-usage => }/mappings.md (94%) diff --git a/astro.config.mjs b/astro.config.mjs index aefcb4857..3fcefb552 100644 --- a/astro.config.mjs +++ b/astro.config.mjs @@ -137,15 +137,15 @@ export default defineConfig({ translations: {}, }, { - label: "Using these docs", - link: "/using_the_docs", + label: "Mappings", + link: "/mappings", collapsed: true, translations: {}, }, { - label: "Basic Usage", + label: "Using these docs", + link: "/using_the_docs", collapsed: true, - autogenerate: { directory: "basic-usage" }, translations: {}, }, { diff --git a/src/content/docs/basic-usage/walkthrough.md b/src/content/docs/basic-usage/walkthrough.md deleted file mode 100644 index 0108485c5..000000000 --- a/src/content/docs/basic-usage/walkthrough.md +++ /dev/null @@ -1,95 +0,0 @@ ---- -id: walkthrough -title: Basic Walkthrough -sidebar_position: 1 ---- - -### Opening file explorer - -To toggle file explorer you need to press `Space` + `e` - -### Opening terminal - -To toggle terminal you need to press `F7` - -### Opening LSP symbols - -To toggle symbols outline you need to press `Space` + `lS` - -### Close buffer - -To close the current buffer you need to press `Space` + `c` - -### Commenting - -To comment on a one or multiple lines you need to press `Space` + `/` - -### Show line diagnostics - -To see line diagnostics you need to press `g` + `l` - -### Hover document - -To hover over a document you need to press `Shift` + `k` - -### Open rename prompt - -To open rename prompt you need to press `Space` + `lr` - -### Go to definition - -To go to the definition you need to press `g` + `d` - -### Code actions - -To use code actions you need to press `Space` + `la` - -### Debugging - -To use the debugger you can press `Space` + `D` to see the available bindings and options - -### Telescope search - -To find files you need to press `Space` + `ff` - -### Telescope grep - -To grep files you need to press `Space` + `fw` - -### Telescope git status - -To get git status you need to press `Space` + `gt` - -### Telescope old files - -To find old files you need to press `Space` + `fo` - -### Which key - -You can use which key plugin to get a menu of some helpful key bindings by pressing `Space` - -### Navigate buffers - -To switch to the left buffer you need to press `[b` - -To switch to the right buffer you need to press `]b` - -### Navigate windows - -To switch to the left window you need to press `Ctrl` + `h` - -To switch to the right window you need to press `Ctrl` + `l` - -To switch to the top window you need to press `Ctrl` + `k` - -To switch to the bottom window you need to press `Ctrl` + `j` - -### Resizing buffers - -To resize buffer to the left you need to press `Ctrl` + `left key` - -To resize buffer to the right you need to press `Ctrl` + `right key` - -To resize buffer to the top you need to press `Ctrl` + `up key` - -To resize buffer to the bottom you need to press `Ctrl` + `down key` diff --git a/src/content/docs/basic-usage/mappings.md b/src/content/docs/mappings.md similarity index 94% rename from src/content/docs/basic-usage/mappings.md rename to src/content/docs/mappings.md index 64a495311..372a8d1f1 100644 --- a/src/content/docs/basic-usage/mappings.md +++ b/src/content/docs/mappings.md @@ -1,14 +1,10 @@ --- id: mappings -title: Default Mappings -sidebar: - # Set a custom label for the link - label: Mappings - # Set a custom order for the link (lower numbers are displayed higher up) - order: 0 - # Add a badge to the link +title: Mappings --- +AstroNvim generally relies on `` driven mappings, which is default set to ``. For information on what the ``, check out the [`:h mapleader`](https://neovim.io/doc/user/map.html#mapleader). [`which-key.nvim`](https://github.com/folke/which-key.nvim) is also used to provide help for discovering and remembering these mappings. Simply press a key like `` and a help menu will pop up with labelled menus and options. + ## General Mappings | Action | Mappings |