From 4fb32dca06e79f7885f9c5f41e2608de5bfb9e04 Mon Sep 17 00:00:00 2001 From: Miguel Useche Date: Sun, 10 Mar 2024 09:57:12 -0500 Subject: [PATCH] fix: some grammar and spelling across walkthrough guide (#206) --- src/routes/docs/config/mappings.mdx | 4 ++-- src/routes/docs/config/nvchad_ui.mdx | 2 +- src/routes/docs/config/plugins.mdx | 3 ++- src/routes/docs/config/theming.mdx | 2 +- src/routes/docs/config/walkthrough.mdx | 4 ++-- src/routes/docs/faq.mdx | 4 ++-- 6 files changed, 10 insertions(+), 9 deletions(-) diff --git a/src/routes/docs/config/mappings.mdx b/src/routes/docs/config/mappings.mdx index 3f32cb3a..735a4ca3 100644 --- a/src/routes/docs/config/mappings.mdx +++ b/src/routes/docs/config/mappings.mdx @@ -5,7 +5,7 @@ export const meta = { ## Overview -The mapping configuration uses the nvim name shorcuts as: +The mapping configuration uses the nvim name shortcuts as: - `` -> Ctrl - `` -> Space @@ -16,7 +16,7 @@ The mapping configuration uses the nvim name shorcuts as: ## Mapping format - NvChad uses `vim.keymap.set` by default, check `:h vim.keymap.set` for detailed docs. -- The desc opt is optional. Its only needed for NvCheatsheet to document, First word in desc will be used for group heading. +- The desc opt is optional. It's only needed for NvCheatsheet to document, First word in desc will be used for group heading. ```lua local map = vim.keymap.set diff --git a/src/routes/docs/config/nvchad_ui.mdx b/src/routes/docs/config/nvchad_ui.mdx index 8255f4b8..08036308 100644 --- a/src/routes/docs/config/nvchad_ui.mdx +++ b/src/routes/docs/config/nvchad_ui.mdx @@ -14,7 +14,7 @@ NvChad's Ui plugin handles the following modules: - The order is a list of module names from default modules + your modules - Removing a word in the order will remove that module -- modules expects all its keys to be a function that returns a string. +- Modules expect all its keys to be a function that returns a string. ```lua M.ui = { diff --git a/src/routes/docs/config/plugins.mdx b/src/routes/docs/config/plugins.mdx index 5fa75a09..841f3a17 100644 --- a/src/routes/docs/config/plugins.mdx +++ b/src/routes/docs/config/plugins.mdx @@ -9,7 +9,8 @@ NvChad uses [lazy.nvim](https://github.com/folke/lazy.nvim) for plugins manageme ## Lazy loading -We lazy load almost 95% of the plugins, so we expect and recommend you to lazy load the plugins as well, as its efficient in reducing startuptime. +We lazy load almost 95% of the plugins, so we expect and recommend you to lazy load the plugins as well, as it's +efficient in reducing startup-time. - We don't want users making NvChad slow just because they didn't lazy load plugins they've added. - Please read the [lazy.nvim plugin specs](https://github.com/folke/lazy.nvim#-plugin-spec) docs to know what options are available for lazyloading etc. diff --git a/src/routes/docs/config/theming.mdx b/src/routes/docs/config/theming.mdx index bd96fdea..043b7441 100644 --- a/src/routes/docs/config/theming.mdx +++ b/src/routes/docs/config/theming.mdx @@ -36,7 +36,7 @@ M.ui = { ```
-In order to add custom highlights, its the same as above, just use **`hl_add`**. +In order to add custom highlights, it's the same as above, just use **`hl_add`**. ## Customize themes diff --git a/src/routes/docs/config/walkthrough.mdx b/src/routes/docs/config/walkthrough.mdx index 188713a1..94237d49 100644 --- a/src/routes/docs/config/walkthrough.mdx +++ b/src/routes/docs/config/walkthrough.mdx @@ -44,7 +44,7 @@ local result = vim.tbl_deep_extend("force", person, someone) - [NvChad/starter](https://github.com/NvChad/starter) - This is a minimal config which shows how to use the nvchad repo as a plugin. - Users will be using the starter config or can create their own - config sturcture of the main nvchad repo : + config structure of the main nvchad repo : ```lua lua │ @@ -81,7 +81,7 @@ You can see all the themes with the following keymap: ` + th`. ## Mappings -If you want to know all the keymaps, you can run the following comands: +If you want to know all the keymaps, you can run the following commands: - `NvCheatsheet` - `Telescope keymaps` diff --git a/src/routes/docs/faq.mdx b/src/routes/docs/faq.mdx index acfba8ad..d4f1d3f8 100644 --- a/src/routes/docs/faq.mdx +++ b/src/routes/docs/faq.mdx @@ -19,7 +19,7 @@ export const meta = { ## Custom local base46 themes -- To make a custom local theme thats of the base46 format, you have to create `/lua/themes/mytheme.lua`. Check [base46 docs](https://github.com/NvChad/base46/blob/v2.0/README.md) for more info. +- To make a custom local theme that's the base46 format, you have to create `/lua/themes/mytheme.lua`. Check [base46 docs](https://github.com/NvChad/base46/blob/v2.0/README.md) for more info. ## Can I remove base46? @@ -37,7 +37,7 @@ key_bindings: - { key: I, mods: Control, chars: "\x1b[105;6u" } ``` -- **NOTE**: keymaps in NvChad are case sensitive, to delete it you need to use lowercase ``. Add this to your mappings.lua: +- **NOTE**: keymaps in NvChad are case-sensitive, to delete it you need to use lowercase ``. Add this to your mappings.lua: ```lua M.disabled = {