Skip to content

Commit

Permalink
remove title and increase header types
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 136b0e9 commit df42caf
Show file tree
Hide file tree
Showing 53 changed files with 119 additions and 331 deletions.
18 changes: 7 additions & 11 deletions cmd/finch/doc.TEMPLATE
Original file line number Diff line number Diff line change
@@ -1,42 +1,38 @@
---
title: "{{ .CmdPath }}"
---

## {{ .CmdPath }}
# {{ .CmdPath }}

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

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

{{.Properties}}

{{end}}```bash
{{ .Usage }}
```{{if gt (len .Aliases) 0}}

### Aliases
## Aliases

{{.Aliases}}
{{end}}{{if gt (len .Examples) 0}}

### Examples
## Examples

{{.Examples}}
{{end}}{{if gt (len .Commands) 0}}

### Commands
## Commands

```bash
{{ .Commands }}
```{{end}}{{if gt (len .Options) 0}}

### Options
## Options

```bash
{{ .Options }}
```{{end}}{{if gt (len .SeeAlso) 0}}

### SEE ALSO
## SEE ALSO

{{ .SeeAlso }}
{{end}}
8 changes: 2 additions & 6 deletions docs/cmd/finch_build.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,4 @@
---
title: "finch build"
---

## finch build
# finch build

Build an image from a Dockerfile. Needs buildkitd to be running.
If Dockerfile is not present and -f is not specified, it will look for Containerfile and build with it.
Expand All @@ -11,7 +7,7 @@ If Dockerfile is not present and -f is not specified, it will look for Container
finch build [flags] PATH
```

### Options
## Options

```bash
--build-arg stringArray Set build-time variables
Expand Down
10 changes: 3 additions & 7 deletions docs/cmd/finch_builder.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,20 @@
---
title: "finch builder"
---

## finch builder
# finch builder

Manage builds

```bash
finch builder [flags]
```

### Commands
## Commands

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

### Options
## Options

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

## finch commit
# finch commit

Create a new image from a container's changes

```bash
finch commit [flags] CONTAINER REPOSITORY[:TAG]
```

### Options
## Options

```bash
-a, --author string Author (e.g., "finch contributor <[email protected]>")
Expand Down
8 changes: 2 additions & 6 deletions docs/cmd/finch_completion_bash.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,4 @@
---
title: "finch completion bash"
---

## finch completion bash
# finch completion bash

Generate the autocompletion script for the bash shell.

Expand All @@ -21,7 +17,7 @@ To load completions for every new session, execute once:
finch completion bash
```

### Options
## Options

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

## finch completion fish
# finch completion fish

Generate the autocompletion script for the fish shell.

Expand All @@ -20,7 +16,7 @@ You will need to start a new shell for this setup to take effect.
finch completion fish [flags]
```

### Options
## Options

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

## finch completion powershell
# finch completion powershell

Generate the autocompletion script for powershell.

Expand All @@ -17,7 +13,7 @@ to your powershell profile.
finch completion powershell [flags]
```

### Options
## Options

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

## finch completion zsh
# finch completion zsh

Generate the autocompletion script for the zsh shell.

Expand All @@ -23,7 +19,7 @@ To load completions for every new session, execute once:
finch completion zsh [flags]
```

### Options
## Options

```bash
-h, --help help for zsh
Expand Down
10 changes: 3 additions & 7 deletions docs/cmd/finch_compose.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,12 @@
---
title: "finch compose"
---

## finch compose
# finch compose

Compose

```bash
finch compose [flags] COMMAND
```

### Commands
## Commands

```bash
build Build or rebuild services
Expand Down Expand Up @@ -38,7 +34,7 @@ finch compose [flags] COMMAND
version Show the Compose version information
```

### Options
## Options

```bash
--env-file string Specify an alternate environment file
Expand Down
10 changes: 3 additions & 7 deletions docs/cmd/finch_container.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,12 @@
---
title: "finch container"
---

## finch container
# finch container

Manage containers

```bash
finch container [flags]
```

### Commands
## Commands

```bash
attach Attach stdin, stdout, and stderr to a running container.
Expand All @@ -37,7 +33,7 @@ finch container [flags]
wait Block until one or more containers stop, then print their exit codes.
```
### Options
## Options
```bash
-h, --help help for container
Expand Down
8 changes: 2 additions & 6 deletions docs/cmd/finch_cp.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,4 @@
---
title: "finch cp"
---

## finch cp
# finch cp

Copy files/folders between a running container and the local filesystem.
This command requires 'tar' to be installed on the host (not in the container).
Expand All @@ -14,7 +10,7 @@ finch cp [flags] CONTAINER:SRC_PATH DEST_PATH|-
finch cp [flags] SRC_PATH|- CONTAINER:DEST_PATH
```

### Options
## Options

```bash
-L, --follow-link Always follow symbolic link in SRC_PATH.
Expand Down
8 changes: 2 additions & 6 deletions docs/cmd/finch_create.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,12 @@
---
title: "finch create"
---

## finch create
# finch create

Create a new container. Optionally specify "ipfs://" or "ipns://" scheme to pull image from IPFS.

```bash
finch create [flags] IMAGE [COMMAND] [ARG...]
```

### Options
## Options

```bash
--add-host strings Add a custom host-to-IP mapping (host:ip)
Expand Down
8 changes: 2 additions & 6 deletions docs/cmd/finch_events.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,12 @@
---
title: "finch events"
---

## finch events
# finch events

Get real time events from the server

```bash
finch events [flags]
```

### Options
## Options

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

## finch exec
# finch exec

Run a command in a running container

```bash
finch exec [flags] CONTAINER COMMAND [ARG...]
```

### Options
## Options

```bash
-d, --detach Detached mode: run command in the background
Expand Down
8 changes: 2 additions & 6 deletions docs/cmd/finch_help.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,4 @@
---
title: "finch help"
---

## finch help
# finch help

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

### Options
## Options

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

## finch history
# finch history

Show the history of an image

```bash
finch history [flags] IMAGE
```

### Options
## Options

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

## finch image
# finch image

Manage images

```bash
finch image [flags]
```

### Commands
## Commands

```bash
build Build an image from a Dockerfile. Needs buildkitd to be running.
Expand All @@ -29,7 +25,7 @@ finch image [flags]
tag Create a tag TARGET_IMAGE that refers to SOURCE_IMAGE
```

### Options
## Options

```bash
-h, --help help for image
Expand Down
Loading

0 comments on commit df42caf

Please sign in to comment.