Skip to content

Commit 427d4c1

Browse files
committed
formatting
1 parent 6fcf8d1 commit 427d4c1

File tree

3 files changed

+23
-23
lines changed

3 files changed

+23
-23
lines changed

docs/introduction/getting_started.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Before you begin, make sure you have the following installed:
2020

2121
On macOS or Linux, you can install Dockform using [Homebrew](https://brew.sh/):
2222

23-
```sh [terminal ~vscode-icons:file-type-shell~]
23+
```sh [shell ~vscode-icons:file-type-shell~]
2424
$ brew tap gcstr/dockform
2525
$ brew install dockform
2626
```
@@ -36,7 +36,7 @@ Download the binary for your platform, extract it, and place it somewhere in you
3636

3737
Dockform includes a convenience command to scaffold a new project:
3838

39-
```sh [terminal ~vscode-icons:file-type-shell~]
39+
```sh [shell ~vscode-icons:file-type-shell~]
4040
dockform init
4141
```
4242

docs/manifest/secrets.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ You need both **SOPS** and **Age** installed:
2222

2323
Generate a new Age key pair and store it locally:
2424

25-
```sh [terminal ~vscode-icons:file-type-shell~]
25+
```sh [shell ~vscode-icons:file-type-shell~]
2626
$ age-keygen -o ~/.config/sops/age/keys.txt
2727
```
2828

@@ -40,7 +40,7 @@ sops:
4040
4141
Use Dockform to scaffold a new secrets file:
4242
43-
```sh [terminal ~vscode-icons:file-type-shell~]
43+
```sh [shell ~vscode-icons:file-type-shell~]
4444
$ dockform secrets create secrets.env
4545
# A template encrypted dotenv file will be created
4646
```
@@ -49,7 +49,7 @@ $ dockform secrets create secrets.env
4949

5050
Open the file securely with your `$EDITOR`. Dockform decrypts it on the fly and re-encrypts on save:
5151

52-
```sh [terminal ~vscode-icons:file-type-shell~]
52+
```sh [shell ~vscode-icons:file-type-shell~]
5353
$ dockform secrets edit secrets.env
5454
```
5555

docs/more/debugging.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -12,14 +12,14 @@ The renderer opens a fullscreen pager in TTY (press `q` to quit, `↑`/`↓`/`Pg
1212

1313
Render the manifest with environment variable interpolation applied. Any missing `${VAR}` will be replaced with an empty string and reported as a warning.
1414

15-
```bash
15+
```bash [shell ~vscode-icons:file-type-shell~]
1616
# From the directory containing your manifest
17-
dockform manifest render
17+
$ dockform manifest render
1818

1919
# Or specify a path (file or directory); discovery order:
2020
# dockform.yml, dockform.yaml, Dockform.yml, Dockform.yaml
21-
dockform manifest render -c ./path/to/dir
22-
dockform manifest render -c ./path/to/dockform.yml
21+
$ dockform manifest render -c ./path/to/dir
22+
$ dockform manifest render -c ./path/to/dockform.yml
2323
```
2424

2525
- **TTY behavior**: Opens a fullscreen pager with highlighted YAML and line numbers.
@@ -28,12 +28,12 @@ dockform manifest render -c ./path/to/dockform.yml
2828

2929
Examples:
3030

31-
```bash
31+
```bash [shell ~vscode-icons:file-type-shell~]
3232
# Pipe the interpolated manifest to a file
33-
dockform manifest render -c ./infra > manifest.debug.yml
33+
$ dockform manifest render -c ./infra > manifest.debug.yml
3434

3535
# Grep for resolved values
36-
dockform manifest render | grep identifier
36+
$ dockform manifest render | grep identifier
3737
```
3838

3939
## Compose rendering
@@ -49,18 +49,18 @@ Render the fully-resolved Docker Compose configuration for a specific applicatio
4949

5050
Usage:
5151

52-
```bash
52+
```bash [shell ~vscode-icons:file-type-shell~]
5353
# Render an app by name (from your manifest’s applications map)
54-
dockform compose render myapp
54+
$ dockform compose render myapp
5555

5656
# Optional flags
57-
dockform compose render myapp --mask full # default
58-
dockform compose render myapp --mask partial # keep 2+2 chars
59-
dockform compose render myapp --mask preserve-length # same length as original
60-
dockform compose render myapp --show-secrets # OPT-IN: disable masking
57+
$ dockform compose render myapp --mask full # default
58+
$ dockform compose render myapp --mask partial # keep 2+2 chars
59+
$ dockform compose render myapp --mask preserve-length # same length as original
60+
$ dockform compose render myapp --show-secrets # OPT-IN: disable masking
6161

6262
# Respect a non-default manifest path
63-
dockform compose render myapp -c ./envs/prod
63+
$ dockform compose render myapp -c ./envs/prod
6464
```
6565

6666
- **TTY behavior**: Opens a fullscreen pager with highlighted YAML, line numbers, and a relative file title (e.g., File: apps/web/docker-compose.yml). If multiple files are merged, the title shows a suffix like (+N).
@@ -69,15 +69,15 @@ dockform compose render myapp -c ./envs/prod
6969

7070
Examples:
7171

72-
```bash
72+
```bash [shell ~vscode-icons:file-type-shell~]
7373
# Save the fully-resolved compose to inspect diffs
74-
dockform compose render api > compose.debug.yml
74+
$ dockform compose render api > compose.debug.yml
7575

7676
# Preview with partial masking
77-
dockform compose render api --mask partial | less -R
77+
$ dockform compose render api --mask partial | less -R
7878

7979
# Force showing secrets (e.g., in CI logs avoid using this)
80-
dockform compose render api --show-secrets
80+
$ dockform compose render api --show-secrets
8181
```
8282

8383
:::: warning

0 commit comments

Comments
 (0)