Skip to content

Commit

Permalink
fix: some grammar and spelling across walkthrough guide (#206)
Browse files Browse the repository at this point in the history
  • Loading branch information
Skatox authored Mar 10, 2024
1 parent 14e2bba commit 4fb32dc
Show file tree
Hide file tree
Showing 6 changed files with 10 additions and 9 deletions.
4 changes: 2 additions & 2 deletions src/routes/docs/config/mappings.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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:

- `<C>` -> <kbd>Ctrl</kbd>
- `<leader>` -> <kbd>Space</kbd>
Expand All @@ -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
Expand Down
2 changes: 1 addition & 1 deletion src/routes/docs/config/nvchad_ui.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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 = {
Expand Down
3 changes: 2 additions & 1 deletion src/routes/docs/config/plugins.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion src/routes/docs/config/theming.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ M.ui = {
```
<br/>

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

Expand Down
4 changes: 2 additions & 2 deletions src/routes/docs/config/walkthrough.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -81,7 +81,7 @@ You can see all the themes with the following keymap: `<leader> + 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`
4 changes: 2 additions & 2 deletions src/routes/docs/faq.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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?
Expand All @@ -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 `<tab>`. Add this to your mappings.lua:
- **NOTE**: keymaps in NvChad are case-sensitive, to delete it you need to use lowercase `<tab>`. Add this to your mappings.lua:
```lua
M.disabled = {
Expand Down

0 comments on commit 4fb32dc

Please sign in to comment.