Skip to content

Commit 7581b05

Browse files
committed
docs: uniformize shell cmd style with rest of docs
1 parent 11e010f commit 7581b05

File tree

1 file changed

+17
-17
lines changed

1 file changed

+17
-17
lines changed

docs/user-guide/install.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -12,23 +12,23 @@ Installation using `pip`
1212

1313
In most cases, installing StagPy with `pip` should be as simple as:
1414

15-
```sh
16-
$ python3 -m pip install stagpy
15+
```sh title="shell"
16+
python3 -m pip install stagpy
1717
```
1818

1919
It might be preferable or even necessary to install StagPy in a virtual
2020
environment to isolate it from other packages that could conflict with it:
2121

22-
```sh
23-
$ python3 -m venv stagpyenv
24-
$ source stagpyenv/bin/activate
25-
$ python3 -m pip install stagpy
22+
```sh title="shell"
23+
python3 -m venv stagpyenv
24+
source stagpyenv/bin/activate
25+
python3 -m pip install stagpy
2626
```
2727

2828
You can then update StagPy with the following command:
2929

30-
```sh
31-
$ python3 -m pip install -U stagpy
30+
```sh title="shell"
31+
python3 -m pip install -U stagpy
3232
```
3333

3434
See the [official
@@ -40,26 +40,26 @@ Some setup
4040

4141
Run the following to create a local config file (`.stagpy.toml`):
4242

43-
```sh
44-
$ stagpy config --create
43+
```sh title="shell"
44+
stagpy config --create
4545
```
4646

4747
You can enable command-line auto-completion if you use either bash or zsh.
4848

4949
For bash::
5050

51-
```sh
51+
```sh title="shell"
5252
# adapt path as appropriate for your system
53-
$ mkdir -p ~/.local/share/bash-completion/completions
54-
$ cd !$
55-
$ stagpy completions --bash
53+
mkdir -p ~/.local/share/bash-completion/completions
54+
cd !$
55+
stagpy completions --bash
5656
```
5757

5858
For zsh, with `fpath+=~/.zfunc` in your `.zshrc`:
5959

60-
```sh
61-
$ cd ~/.zfunc
62-
$ stagpy completions --zsh
60+
```sh title="shell"
61+
cd ~/.zfunc
62+
stagpy completions --zsh
6363
```
6464

6565
Enjoy!

0 commit comments

Comments
 (0)