Skip to content

Commit b723ca9

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

File tree

7 files changed

+16
-16
lines changed

7 files changed

+16
-16
lines changed

src/content/docs/configuration/config.mdx

Lines changed: 6 additions & 7 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
@@ -432,8 +432,7 @@ keybindings in the shells). There are four supported values: `"emacs"`,
432432
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"`,
435-
you can search for a string as in the keymap mode `"emacs"`, while pressing <kbd>
436-
Esc
435+
you can search for a string as in the keymap mode `"emacs"`, while pressing <kbd> Esc
437436
</kbd> switches the keymap mode to `"vim-normal"`. When set to `"auto"`, the initial
438437
keymap mode is automatically determined based on the shell's keymap that triggered
439438
the Atuin search. `"auto"` is not supported by NuShell at present, where it will
@@ -477,7 +476,7 @@ Alternatively, set env var NO_MOTION
477476

478477
This section of client config is specifically for configuring Atuin stats calculations
479478

480-
```
479+
```toml
481480
[stats]
482481
common_subcommands = [...]
483482
common_prefix = [...]
@@ -570,7 +569,7 @@ atuin dotfiles alias list
570569
atuin dotfiles alias delete k
571570
```
572571

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

575574
## keys
576575

@@ -700,7 +699,7 @@ Default: `""`
700699

701700
A theme name that must be present as a built-in (an empty string for the default,
702701
`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
702+
By default, this is `~/.config/atuin/themes/` but can be overridden with the
704703
`ATUIN_THEME_DIR` environment variable.
705704

706705
```toml

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

Lines changed: 2 additions & 2 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,7 +54,7 @@ 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
```

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+
```shell
1011
atuin import auto
1112
```
1213

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

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

src/content/docs/guide/theming.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ key is missing in the `theme` block, from the default theme.
105105
This theme file should be moved to `~/.config/atuin/themes/my-theme.toml` and the
106106
following added to `~/.config/atuin/config.toml`:
107107

108-
```
108+
```toml
109109
[theme]
110110
name = "my-theme"
111111
```

src/content/docs/reference/import.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ HISTFILE=/path/to/history/file atuin import zsh
2020
```
2121

2222
Note that for shells such as Xonsh that store history in many files rather than a
23-
single file, `$HISTFILE` should be set to the directory in whic those files reside.
23+
single file, `$HISTFILE` should be set to the directory in which those files reside.
2424

2525
For formats that don't store timestamps, timestamps will be generated starting at
2626
the current time plus 1ms for each additional command in the history.

src/content/docs/self-hosting/docker.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ Start and enable the service with:
9595
systemctl enable --now atuin
9696
```
9797

98-
Check if its running with:
98+
Check if it's running with:
9999

100100
```sh
101101
systemctl status atuin

src/content/docs/self-hosting/kubernetes.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -231,7 +231,7 @@ Note that this configuration will store the database folder _outside_ the kubern
231231

232232
You should also change the password string in `ATUIN_DB_PASSWORD` and `ATUIN_DB_URI` in the`secrets.yaml` file to a more secure one.
233233

234-
The atuin service on the port `30530` of the host system. That is configured by the `nodePort` property. Kubernetes has a strict rule that you are not allowed to expose a port numbered lower than 30000. To make the clients work, you can simply set the port in in your `config.toml` file, e.g. `sync_address = "http://192.168.1.10:30530"`.
234+
The atuin service on the port `30530` of the host system. That is configured by the `nodePort` property. Kubernetes has a strict rule that you are not allowed to expose a port numbered lower than 30000. To make the clients work, you can simply set the port in your `config.toml` file, e.g. `sync_address = "http://192.168.1.10:30530"`.
235235

236236
Deploy the Atuin server using `kubectl`:
237237

@@ -290,4 +290,4 @@ spec:
290290
Configure/update the example `yaml` with the following:
291291
- Set a more or less frequent schedule with the `schedule` property.
292292
- Replace `/somewhere/on/node/for/database-backups` with a path on your node or reconfigure to use a `PersistentVolume` instead of `hostPath`.
293-
- `--format=c` ouputs a format that can be restored with `pg_restore`. Use [`plain`](https://www.postgresql.org/docs/current/app-pgdump.html) if you want `.sql` files outputted instead.
293+
- `--format=c` outputs a format that can be restored with `pg_restore`. Use [`plain`](https://www.postgresql.org/docs/current/app-pgdump.html) if you want `.sql` files outputted instead.

0 commit comments

Comments
 (0)