From 7c69d9bf319a85a50cc6fb426da5ef87aedb2751 Mon Sep 17 00:00:00 2001 From: rsteube Date: Thu, 12 May 2022 15:00:17 +0200 Subject: [PATCH] updated doc --- docs/book.toml | 2 ++ docs/src/carapace-spec/macros.md | 2 +- docs/src/carapace-spec/macros/core.md | 2 +- docs/src/carapace-spec/macros/custom.md | 2 +- docs/src/carapace-spec/macros/modifier.md | 2 +- 5 files changed, 6 insertions(+), 4 deletions(-) diff --git a/docs/book.toml b/docs/book.toml index 4a445b6..918fda7 100644 --- a/docs/book.toml +++ b/docs/book.toml @@ -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] diff --git a/docs/src/carapace-spec/macros.md b/docs/src/carapace-spec/macros.md index 48841ab..13e2265 100644 --- a/docs/src/carapace-spec/macros.md +++ b/docs/src/carapace-spec/macros.md @@ -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()`). diff --git a/docs/src/carapace-spec/macros/core.md b/docs/src/carapace-spec/macros/core.md index 2ed50aa..112b933 100644 --- a/docs/src/carapace-spec/macros/core.md +++ b/docs/src/carapace-spec/macros/core.md @@ -9,7 +9,7 @@ Core macros provided by [carapace-spec](https://github.com/rsteube/carapace-spec ["$directories"] ``` -## execcommand +## exec [`$()`](https://rsteube.github.io/carapace/carapace/action/actionExecCommand.html) executes given command in a `sh` / `pwsh` shell. diff --git a/docs/src/carapace-spec/macros/custom.md b/docs/src/carapace-spec/macros/custom.md index 82be19c..07e7f1d 100644 --- a/docs/src/carapace-spec/macros/custom.md +++ b/docs/src/carapace-spec/macros/custom.md @@ -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) diff --git a/docs/src/carapace-spec/macros/modifier.md b/docs/src/carapace-spec/macros/modifier.md index 05b1cc6..f648dac 100644 --- a/docs/src/carapace-spec/macros/modifier.md +++ b/docs/src/carapace-spec/macros/modifier.md @@ -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"]