Skip to content

Commit 537cd5d

Browse files
committed
chore: add language to code blocks and fix typos
1 parent 9b207d5 commit 537cd5d

File tree

18 files changed

+89
-88
lines changed

18 files changed

+89
-88
lines changed

src/content/docs/configuration/config.mdx

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -161,7 +161,7 @@ Atuin version: >= 17.0
161161

162162
Default: `fuzzy`
163163

164-
The default searchmode to use when searching and being invoked from a shell up-key binding.
164+
The default search mode to use when searching and being invoked from a shell up-key binding.
165165

166166
Accepts exactly the same options as `search_mode` above
167167

@@ -356,7 +356,7 @@ secrets_filter = true
356356
This matches history against a set of default regex, and will not save it if we get a match. Defaults include
357357

358358
1. AWS key id
359-
2. Github pat (old and new)
359+
2. GitHub pat (old and new)
360360
3. Slack oauth tokens (bot, user)
361361
4. Slack webhooks
362362
5. Stripe live/test keys
@@ -433,7 +433,7 @@ most basic one. In the keymap mode `"vim-normal"`, you may use <kbd>k</kbd>
433433
and <kbd>j</kbd> to navigate the history list as in Vim, whilst pressing
434434
<kbd>i</kbd> changes the keymap mode to `"vim-insert"`. In the keymap mode `"vim-insert"`,
435435
you can search for a string as in the keymap mode `"emacs"`, while pressing <kbd>
436-
Esc
436+
Esc
437437
</kbd> switches the keymap mode to `"vim-normal"`. When set to `"auto"`, the initial
438438
keymap mode is automatically determined based on the shell's keymap that triggered
439439
the Atuin search. `"auto"` is not supported by NuShell at present, where it will
@@ -477,7 +477,7 @@ Alternatively, set env var NO_MOTION
477477

478478
This section of client config is specifically for configuring Atuin stats calculations
479479

480-
```
480+
```toml
481481
[stats]
482482
common_subcommands = [...]
483483
common_prefix = [...]
@@ -559,7 +559,7 @@ Note: you will need to have sync v2 enabled. See the above section.
559559

560560
Manage aliases using the command line options
561561

562-
```
562+
```bash
563563
# Alias 'k' to 'kubectl'
564564
atuin dotfiles alias set k kubectl
565565

@@ -570,13 +570,13 @@ atuin dotfiles alias list
570570
atuin dotfiles alias delete k
571571
```
572572

573-
After setting an alias, you will either need to restart your shell or source the init file for the change to take affect
573+
After setting an alias, you will either need to restart your shell or source the init file for the change to take effect
574574

575575
## keys
576576

577577
This section of the client config is specifically for configuring key-related settings.
578578

579-
```
579+
```toml
580580
[keys]
581581
scroll_exits = [...]
582582
prefix = 'a'
@@ -603,7 +603,7 @@ Which key to use as the prefix
603603
This section of the client config is specifically for configuring preview-related settings.
604604
(In the future the other 2 preview settings will be moved here.)
605605

606-
```
606+
```toml
607607
[preview]
608608
strategy = [...]
609609
```
@@ -700,7 +700,7 @@ Default: `""`
700700

701701
A theme name that must be present as a built-in (an empty string for the default,
702702
`autumn` or `marine`), or found in the themes directory, with the suffix `.toml`.
703-
By default this is `~/.config/atuin/themes/` but can be overridden with the
703+
By default, this is `~/.config/atuin/themes/` but can be overridden with the
704704
`ATUIN_THEME_DIR` environment variable.
705705

706706
```toml

src/content/docs/configuration/key-binding.mdx

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,8 @@ You can also disable either the up-arrow or <kbd>Ctrl-r</kbd> bindings individua
2626
`--disable-up-arrow` or `--disable-ctrl-r` to the call to `atuin init` in your shell config file:
2727

2828
An example for zsh:
29-
```
29+
30+
```zsh
3031
# Bind ctrl-r but not up arrow
3132
eval "$(atuin init zsh --disable-up-arrow)"
3233

@@ -71,7 +72,7 @@ can be used for the keybindings to the <kbd>up</kbd> key and similar keys.
7172

7273
Note: instead use the widget names "\_atuin\_search\_widget" and "\_atuin\_up\_search\_widget", respectively, in `atuin < 18.0`
7374

74-
```
75+
```zsh
7576
export ATUIN_NOBIND="true"
7677
eval "$(atuin init zsh)"
7778

@@ -94,7 +95,7 @@ Atuin provides a bindable shell function "`__atuin_history`" for keybindings in
9495
Bash. The flag `--shell-up-key-binding` can be optionally specified to the
9596
first argument for keybindings to the <kbd>up</kbd> key or similar keys.
9697

97-
```
98+
```bash
9899
export ATUIN_NOBIND="true"
99100
eval "$(atuin init bash)"
100101

@@ -116,7 +117,7 @@ combination with the config
116117
## fish
117118
Edit key bindings in FISH shell by adding the following to ~/.config/fish/config.fish
118119

119-
```
120+
```fish
120121
set -gx ATUIN_NOBIND "true"
121122
atuin init fish | source
122123
@@ -201,7 +202,7 @@ If [vim is enabled in the config](https://docs.atuin.sh/configuration/config/#vi
201202

202203

203204
### Inspector
204-
Open the inspector with ctrl-o
205+
Open the inspector with ctrl-o
205206

206207
| Shortcut | Action |
207208
| -------- | --------------------------------------------- |

src/content/docs/faq.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Add `--disable-up-arrow`
1010

1111
EG:
1212

13-
```
13+
```bash
1414
eval "$(atuin init zsh --disable-up-arrow)"
1515
```
1616

@@ -26,7 +26,7 @@ You can make `enter` edit a command by putting `enter_accept = false` into your
2626

2727
**Attention:** This command does not prompt for confirmation.
2828

29-
```
29+
```bash
3030
atuin account delete
3131
```
3232

src/content/docs/guide/basic-usage.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ Read more [here](/configuration/key-binding/)
4444

4545
You may prefer that Atuin always inserts the selected command for editing. To configure this, set
4646

47-
```
47+
```toml
4848
enter_accept = false
4949
```
5050

@@ -54,13 +54,13 @@ in your config file.
5454

5555
If you find the full screen TUI overwhelming or too much, you can adjust it like so
5656

57-
```
57+
```toml
5858
# height of the search window
5959
inline_height = 40
6060
```
6161

6262
You may also prefer the compact UI mode
6363

64-
```
64+
```toml
6565
style = "compact"
6666
```

src/content/docs/guide/dotfiles.mdx

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ to work with.
99
At the moment, we support managing and syncing of shell aliases and environment variables - with more
1010
coming soon.
1111

12-
The following shells are supported:
12+
The following shells are supported:
1313

1414
- zsh
1515
- bash
@@ -23,7 +23,7 @@ no longer need to edit your config files manually.
2323

2424
Once Atuin is setup and installed, the following is required in your config file (`~/.config/atuin/config.toml`)
2525

26-
```
26+
```toml
2727
[dotfiles]
2828
enabled = true
2929
```
@@ -32,7 +32,7 @@ In a later release, this will be enabled by default.
3232

3333
Note: If you have not yet setup sync v2, please also add
3434

35-
```
35+
```toml
3636
[sync]
3737
records = true
3838
```
@@ -43,69 +43,69 @@ to the same config file.
4343

4444
## Aliases
4545

46-
After creating or deleting an alias, remember to restart your shell!
46+
After creating or deleting an alias, remember to restart your shell!
4747

4848
### Creating an alias
4949

50-
```
50+
```bash
5151
atuin dotfiles alias set NAME 'COMMAND'
5252
```
5353

5454
For example, to alias `k` to be `kubectl`
5555

5656

57-
```
57+
```bash
5858
atuin dotfiles alias set k 'kubectl'
5959
```
6060

6161
or to alias `ll` to be `ls -lah`
6262

63-
```
63+
```bash
6464
atuin dotfiles alias set ll 'ls -lah'
6565
```
6666

6767
### Deleting an alias
6868

6969
Deleting an alias is as simple as:
7070

71-
```
71+
```bash
7272
atuin dotfiles alias delete NAME
7373
```
7474

7575
For example, to delete the above alias `k`:
7676

77-
```
77+
```bash
7878
atuin dotfiles alias delete k
7979
```
8080

8181
### Listing aliases
8282

8383
You can list all aliases with:
8484

85-
```
85+
```bash
8686
atuin dotfiles alias list
8787
```
8888

8989
## Env vars
9090

91-
After creating or deleting an env var, remember to restart your shell!
91+
After creating or deleting an env var, remember to restart your shell!
9292

93-
### Creating a var
93+
### Creating a var
9494

95-
```
95+
```bash
9696
atuin dotfiles var set NAME 'value'
9797
```
9898

9999
For example, to set `FOO` to be `bar`
100100

101101

102-
```
102+
```bash
103103
atuin dotfiles var set FOO 'bar'
104104
```
105105

106106
Vars are exported by default, but you can create a shell var like so
107107

108-
```
108+
```bash
109109
atuin dotfiles var set -n foo 'bar'
110110
```
111111

@@ -114,28 +114,28 @@ atuin dotfiles var set -n foo 'bar'
114114

115115
Deleting a var is as simple as:
116116

117-
```
117+
```bash
118118
atuin dotfiles var delete NAME
119119
```
120120

121121
For example, to delete the above var `FOO`:
122122

123-
```
123+
```bash
124124
atuin dotfiles var delete FOO
125125
```
126126

127127
### Listing vars
128128

129129
You can list all vars with:
130130

131-
```
131+
```bash
132132
atuin dotfiles var list
133133
```
134134

135135
## Syncing and backing up dotfiles
136-
If you have [setup sync](/guide/sync), then running
136+
If you have [setup sync](/guide/sync), then running
137137

138-
```
138+
```bash
139139
atuin sync
140140
```
141141

src/content/docs/guide/getting-started.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,15 +28,15 @@ If you have any problems, please open an [issue](https://github.com/ellie/atuin/
2828
Please do try and read this guide, but if you're in a hurry and want to get
2929
started quickly:
3030

31-
```
31+
```bash
3232
bash <(curl --proto '=https' --tlsv1.2 -sSf https://setup.atuin.sh)
3333

3434
atuin register -u <USERNAME> -e <EMAIL>
3535
atuin import auto
3636
atuin sync
3737
```
3838

39-
Now restart your shell!
39+
Now restart your shell!
4040

4141
Anytime you press ctrl-r or up, you will see the Atuin search UI. Type your
4242
query, enter to execute. If you'd like to select a command without executing
@@ -48,7 +48,7 @@ bindings](https://atuin.sh/docs/key-binding#disable-up-arrow)
4848

4949
Note: The above sync and registration is fully optional. If you'd like to use Atuin offline, you can run
5050

51-
```
51+
```bash
5252
bash <(curl --proto '=https' --tlsv1.2 -sSf https://setup.atuin.sh)
5353

5454
atuin import auto

src/content/docs/guide/import.mdx

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,14 @@ Atuin uses a shell plugin to ensure that we capture new shell history. But for
66
older history, you will need to import it
77

88
This will import the history for your current shell:
9-
```
9+
10+
```bash
1011
atuin import auto
1112
```
1213

1314
Alternatively, you can specify the shell like so:
1415

15-
```
16+
```bash
1617
atuin import bash
1718
atuin import zsh # etc
1819
```

0 commit comments

Comments
 (0)