Skip to content

Commit 8ad0a7e

Browse files
committed
Fix Badges
1 parent 6b30065 commit 8ad0a7e

File tree

2 files changed

+10
-8
lines changed

2 files changed

+10
-8
lines changed

.vitepress/theme/index.js

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@ import DefaultTheme from 'vitepress/theme'
22
import './custom.css'
33
import 'virtual:group-icons.css'
44

5+
import { VPBadge } from 'vitepress/theme-without-fonts'
56
import Contributors from './components/Contributors.vue'
67
import YouTubeEmbed from './components/YouTubeEmbed.vue'
78

@@ -10,6 +11,7 @@ export default {
1011
...DefaultTheme,
1112

1213
enhanceApp({ app }) {
14+
app.component('Badge', VPBadge)
1315
app.component('Contributors', Contributors)
1416
app.component('YouTubeEmbed', YouTubeEmbed)
1517
},

docs/docs/inputs.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ The inputs are organized in a table for quick [reference](#reference) with addit
3434
3535
## Details
3636

37-
### name
37+
### name <Badge type="warning" text="Required" />
3838

3939
Swarm sack name or Compose project name.
4040

@@ -52,7 +52,7 @@ and the `-f` flag will be automatically prepended to each file.
5252
Example: `web.yaml db.yaml`
5353
Output: `-f web.yaml -f db.yaml`
5454

55-
### mode <Badge type="warning" text="Compose Only" />
55+
### mode <Badge type="tip" text="Compose Only" />
5656

5757
Enable Docker Compose mode by setting this to `compose`.
5858

@@ -61,7 +61,7 @@ instead of [stack deploy](https://docs.docker.com/reference/cli/docker/stack/dep
6161

6262
Example: `compose`
6363

64-
### args <Badge type="warning" text="Compose Only" /> {#args}
64+
### args <Badge type="tip" text="Compose Only" />
6565

6666
Compose arguments to pass to the `compose up` command. Only used for `mode: compose` deployments.
6767
The `detach` flag defaults to false for compose. With no args the default is `--remove-orphans --force-recreate`.
@@ -70,7 +70,7 @@ Use an empty string to override. For more details, see the compose
7070

7171
Example: `--remove-orphans --force-recreate`
7272

73-
### host
73+
### host <Badge type="warning" text="Required" />
7474

7575
The hostname or IP address of the remote docker server to deploy too.
7676
If your hostname is behind a proxy like Cloudflare you will need to use the IP address.
@@ -97,7 +97,7 @@ dig TXT +short o-o.myaddr.l.google.com @ns1.google.com
9797

9898
:::
9999

100-
### pass/ssh_key
100+
### pass/ssh_key <Badge type="warning" text="Required" /> {#pass-ssh-key}
101101

102102
You must provide either a `pass` or `ssh_key`, but **not** both.
103103

@@ -137,7 +137,7 @@ _Compose._ You can also add to the [args](#args) with `--env-file stringArray`.
137137
That is set in your compose file as normal.
138138
:::
139139

140-
### detach <Badge type="warning" text="Swarm Only" /> {#detach}
140+
### detach <Badge type="tip" text="Swarm Only" />
141141

142142
Set this to `false` to not exit immediately and wait for the services to converge.
143143
This will generate extra output in the logs and is useful for debugging deployments.
@@ -146,13 +146,13 @@ Defaults to `false` in `mode: compose`.
146146

147147
See the [stack deploy Options](https://docs.docker.com/reference/cli/docker/stack/deploy/#options) for more details.
148148

149-
### resolve_image <Badge type="warning" text="Swarm Only" /> {#resolve-image}
149+
### resolve_image <Badge type="tip" text="Swarm Only" /> {#resolve-image}
150150

151151
When the default `always` is used, this argument is omitted.
152152

153153
See the [stack deploy Options](https://docs.docker.com/reference/cli/docker/stack/deploy/#options) for more details.
154154

155-
### registry_auth <Badge type="warning" text="Swarm Only" /> {#registry-auth}
155+
### registry_auth <Badge type="tip" text="Swarm Only" /> {#registry-auth}
156156

157157
Set to `true` to deploy with `--with-registry-auth`.
158158

0 commit comments

Comments
 (0)