aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSidhanth Rathod <siduck@tutanota.com>2022-04-22 13:24:50 +0530
committerGitHub <noreply@github.com>2022-04-22 13:24:50 +0530
commit528ecac3901ea80251cad81eb7b668ec963c315e (patch)
tree146f25c0e2e1a5d974f891e658947cc4155cf565
parentadd term_opts config shortcut (diff)
parentfix formatting (diff)
Merge pull request #2 from ahhshm/patch-1
fix formatting
-rw-r--r--README.md14
1 files changed, 7 insertions, 7 deletions
diff --git a/README.md b/README.md
index 9ec0a06..4533861 100644
--- a/README.md
+++ b/README.md
@@ -1,8 +1,8 @@
# NvChad Official Terminal Plugin
-## Setup:
+## Setup
-### Installation:
+### Installation
Simply install the plugin with packer as you would for any other:
@@ -15,7 +15,7 @@ use {
}
```
-### Configuration:
+### Configuration
Pass a table of configuration options to the plugin's `.setup()` function above.
A sample configuration table with the default options is shown below:
@@ -50,7 +50,7 @@ require("nvterm").setup({
})
```
A shortcut is available for setting options of the different terminal types:
-```
+```lua
require("nvterm").setup({
float = {
relative = 'editor',
@@ -67,7 +67,7 @@ require("nvterm").setup({
is equivalent to:
-```
+```lua
require("nvterm").setup({
terminals = {
type_opts = {
@@ -86,10 +86,10 @@ require("nvterm").setup({
})
```
-### Additional Functionality:
+### Additional Functionality
NvTerm provides an api for you to send commands to the terminal. You can create different ones for different filetypes like so:
-```
+```lua
require("nvterm").setup()
local terminal = require("nvterm.terminal")