Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

updated doc #65

Merged
merged 1 commit into from
Oct 16, 2022
Merged

updated doc #65

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/book.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,7 @@ title = "carapace-spec"
default-theme = "Mocha"
additional-css = ["asciinema/asciinema-player.css", "./theme/catppuccin.css", "./theme/catppuccin-highlight.css"]
additional-js = ["asciinema/asciinema-player.min.js", "asciinema/load.js"]
git-repository-url = "https://github.com/rsteube/carapace-spec"
edit-url-template = "https://github.com/rsteube/carapace-spec/edit/master/docs/{path}"

#[output.linkcheck]
2 changes: 1 addition & 1 deletion docs/src/carapace-spec/macros.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@

Macros are basically [Actions](https://rsteube.github.io/carapace/carapace/action.html) exposed to the spec (E.g. [`$files([.go, go.mod])`](https://rsteube.github.io/carapace/carapace/action/actionFiles.html).

The brackets are optional if no argument is passed (so `$files` is equivalent to `$files()`).
> The brackets are optional if no argument is passed (so `$files` is equivalent to `$files()`).
2 changes: 1 addition & 1 deletion docs/src/carapace-spec/macros/core.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Core macros provided by [carapace-spec](https://github.com/rsteube/carapace-spec
["$directories"]
```

## execcommand
## exec

[`$(<command>)`](https://rsteube.github.io/carapace/carapace/action/actionExecCommand.html) executes given command in a `sh` / `pwsh` shell.

Expand Down
2 changes: 1 addition & 1 deletion docs/src/carapace-spec/macros/custom.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ AddMacro("arg", MacroI(func(u User) carapace.Action { return carapace.ActionValu
AddMacro("vararg", MacroV(func(s ...string) carapace.Action { return carapace.ActionValues()}))
```

Arguments are parsed as `yaml` so only struct keys deviating from the default need to be set.
> Arguments are parsed as `yaml` so only struct keys deviating from the default need to be set.

## Default (experimental)

Expand Down
2 changes: 1 addition & 1 deletion docs/src/carapace-spec/macros/modifier.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ Modifiers change the completion for a position in general.

## noflag

`$noflag` disables flag parsing for the current command.
`$noflag` disables flag parsing for the corresponding (sub)command.

```yml
["$noflag"]
Expand Down