Skip to content

Commit

Permalink
fix mdlint
Browse files Browse the repository at this point in the history
Signed-off-by: Justin Alvarez <[email protected]>
  • Loading branch information
pendo324 committed Oct 20, 2023
1 parent 661c93c commit c06d3d0
Show file tree
Hide file tree
Showing 53 changed files with 118 additions and 3 deletions.
9 changes: 6 additions & 3 deletions cmd/finch/doc.TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,12 @@
---
title: "{{ .CmdPath }}"
---

## {{ .CmdPath }}{{if gt (len .Description) 0}}

{{ .Description }}

{{end}}

{{if gt (len .Properties) 0}}### Properties
{{end}}{{if gt (len .Properties) 0}}### Properties

{{.Properties}}

Expand All @@ -16,19 +15,23 @@ title: "{{ .CmdPath }}"
```{{if gt (len .Aliases) 0}}
### Aliases
{{.Aliases}}
{{end}}{{if gt (len .Examples) 0}}
### Examples
{{.Examples}}
{{end}}{{if gt (len .Commands) 0}}
### Commands
```
{{ .Commands }}
```{{end}}{{if gt (len .Options) 0}}
### Options
```
{{ .Options }}
```{{end}}{{if gt (len .SeeAlso) 0}}
Expand Down
2 changes: 2 additions & 0 deletions docs/cmd/finch_build.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: "finch build"
---

## finch build

Build an image from a Dockerfile. Needs buildkitd to be running.
Expand All @@ -11,6 +12,7 @@ finch build [flags] PATH
```

### Options

```
--build-arg stringArray Set build-time variables
--buildkit-host string BuildKit address [$BUILDKIT_HOST] (default "unix:///run/buildkit/buildkitd.sock")
Expand Down
3 changes: 3 additions & 0 deletions docs/cmd/finch_builder.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: "finch builder"
---

## finch builder

Manage builds
Expand All @@ -10,13 +11,15 @@ finch builder [flags]
```

### Commands

```
build Build an image from a Dockerfile. Needs buildkitd to be running.
debug Debug Dockerfile
prune Clean up BuildKit build cache
```

### Options

```
-h, --help help for builder
```
2 changes: 2 additions & 0 deletions docs/cmd/finch_commit.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: "finch commit"
---

## finch commit

Create a new image from a container's changes
Expand All @@ -10,6 +11,7 @@ finch commit [flags] CONTAINER REPOSITORY[:TAG]
```

### Options

```
-a, --author string Author (e.g., "finch contributor <[email protected]>")
-c, --change stringArray Apply Dockerfile instruction to the created image (supported directives: [CMD, ENTRYPOINT])
Expand Down
2 changes: 2 additions & 0 deletions docs/cmd/finch_completion_bash.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: "finch completion bash"
---

## finch completion bash

Generate the autocompletion script for the bash shell.
Expand All @@ -21,6 +22,7 @@ To load completions for every new session, execute once:
```

### Options

```
-h, --help help for bash
--no-descriptions disable completion descriptions
Expand Down
2 changes: 2 additions & 0 deletions docs/cmd/finch_completion_fish.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: "finch completion fish"
---

## finch completion fish

Generate the autocompletion script for the fish shell.
Expand All @@ -20,6 +21,7 @@ You will need to start a new shell for this setup to take effect.
```

### Options

```
-h, --help help for fish
--no-descriptions disable completion descriptions
Expand Down
2 changes: 2 additions & 0 deletions docs/cmd/finch_completion_powershell.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: "finch completion powershell"
---

## finch completion powershell

Generate the autocompletion script for powershell.
Expand All @@ -17,6 +18,7 @@ to your powershell profile.
```

### Options

```
-h, --help help for powershell
--no-descriptions disable completion descriptions
Expand Down
2 changes: 2 additions & 0 deletions docs/cmd/finch_completion_zsh.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: "finch completion zsh"
---

## finch completion zsh

Generate the autocompletion script for the zsh shell.
Expand All @@ -23,6 +24,7 @@ To load completions for every new session, execute once:
```

### Options

```
-h, --help help for zsh
--no-descriptions disable completion descriptions
Expand Down
3 changes: 3 additions & 0 deletions docs/cmd/finch_compose.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: "finch compose"
---

## finch compose

Compose
Expand All @@ -10,6 +11,7 @@ finch compose [flags] COMMAND
```

### Commands

```
build Build or rebuild services
config Validate and view the Compose file
Expand Down Expand Up @@ -37,6 +39,7 @@ finch compose [flags] COMMAND
```

### Options

```
--env-file string Specify an alternate environment file
-f, --f stringArray Alias of --file
Expand Down
3 changes: 3 additions & 0 deletions docs/cmd/finch_container.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: "finch container"
---

## finch container

Manage containers
Expand All @@ -10,6 +11,7 @@ finch container [flags]
```

### Commands

```
attach Attach stdin, stdout, and stderr to a running container.
commit Create a new image from a container's changes
Expand All @@ -36,6 +38,7 @@ finch container [flags]
```

### Options

```
-h, --help help for container
```
2 changes: 2 additions & 0 deletions docs/cmd/finch_cp.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: "finch cp"
---

## finch cp

Copy files/folders between a running container and the local filesystem.
Expand All @@ -14,6 +15,7 @@ finch cp [flags] CONTAINER:SRC_PATH DEST_PATH|-
```

### Options

```
-L, --follow-link Always follow symbolic link in SRC_PATH.
-h, --help help for cp
Expand Down
2 changes: 2 additions & 0 deletions docs/cmd/finch_create.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: "finch create"
---

## finch create

Create a new container. Optionally specify "ipfs://" or "ipns://" scheme to pull image from IPFS.
Expand All @@ -10,6 +11,7 @@ finch create [flags] IMAGE [COMMAND] [ARG...]
```

### Options

```
--add-host strings Add a custom host-to-IP mapping (host:ip)
--blkio-weight uint16 Block IO (relative weight), between 10 and 1000, or 0 to disable (default 0)
Expand Down
2 changes: 2 additions & 0 deletions docs/cmd/finch_events.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: "finch events"
---

## finch events

Get real time events from the server
Expand All @@ -10,6 +11,7 @@ finch events [flags]
```

### Options

```
--format string Format the output using the given Go template, e.g, '{{json .}}'
-h, --help help for events
Expand Down
2 changes: 2 additions & 0 deletions docs/cmd/finch_exec.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: "finch exec"
---

## finch exec

Run a command in a running container
Expand All @@ -10,6 +11,7 @@ finch exec [flags] CONTAINER COMMAND [ARG...]
```

### Options

```
-d, --detach Detached mode: run command in the background
-e, --env stringArray Set environment variables
Expand Down
2 changes: 2 additions & 0 deletions docs/cmd/finch_help.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: "finch help"
---

## finch help

Help provides help for any command in the application.
Expand All @@ -11,6 +12,7 @@ Simply type finch help [path to command] for full details.
```

### Options

```
-h, --help help for help
```
2 changes: 2 additions & 0 deletions docs/cmd/finch_history.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: "finch history"
---

## finch history

Show the history of an image
Expand All @@ -10,6 +11,7 @@ finch history [flags] IMAGE
```

### Options

```
-f, --format string Format the output using the given Go template, e.g, '{{json .}}'
-h, --help help for history
Expand Down
3 changes: 3 additions & 0 deletions docs/cmd/finch_image.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: "finch image"
---

## finch image

Manage images
Expand All @@ -10,6 +11,7 @@ finch image [flags]
```

### Commands

```
build Build an image from a Dockerfile. Needs buildkitd to be running.
convert convert an image
Expand All @@ -28,6 +30,7 @@ finch image [flags]
```

### Options

```
-h, --help help for image
```
3 changes: 3 additions & 0 deletions docs/cmd/finch_images.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
---
title: "finch images"
---

## finch images

List images

### Properties

- REPOSITORY: Repository
- TAG: Tag
- NAME: Name of the image, --names for skip parsing as repository and tag.
Expand All @@ -20,6 +22,7 @@ finch images [flags] [REPOSITORY[:TAG]]
```

### Options

```
-a, --all (unimplemented yet, always true) (default true)
--digests Show digests (compatible with Docker, unlike ID)
Expand Down
2 changes: 2 additions & 0 deletions docs/cmd/finch_info.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: "finch info"
---

## finch info

Display system-wide information
Expand All @@ -10,6 +11,7 @@ finch info [flags]
```

### Options

```
-f, --format string Format the output using the given Go template, e.g, '{{json .}}'
-h, --help help for info
Expand Down
2 changes: 2 additions & 0 deletions docs/cmd/finch_inspect.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: "finch inspect"
---

## finch inspect

Return low-level information on objects.
Expand All @@ -10,6 +11,7 @@ finch inspect [flags]
```

### Options

```
-f, --format string Format the output using the given Go template, e.g, '{{json .}}'
-h, --help help for inspect
Expand Down
2 changes: 2 additions & 0 deletions docs/cmd/finch_kill.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: "finch kill"
---

## finch kill

Kill one or more running containers
Expand All @@ -10,6 +11,7 @@ finch kill [flags] CONTAINER [CONTAINER, ...]
```

### Options

```
-h, --help help for kill
-s, --signal string Signal to send to the container (default "KILL")
Expand Down
Loading

0 comments on commit c06d3d0

Please sign in to comment.