From 48746495d456d8d3f40f68887d004a73f71ec99f Mon Sep 17 00:00:00 2001 From: "L. Yeung" Date: Mon, 16 May 2022 23:22:49 +0800 Subject: [PATCH] docs(configuration): revise reference links --- website/docs/configuration/debug-prompt.md | 4 ++-- website/docs/configuration/line-error.md | 2 +- website/docs/configuration/secondary-prompt.md | 2 +- website/docs/configuration/segment.md | 2 +- website/docs/configuration/title.md | 1 - website/docs/configuration/transient.mdx | 2 +- 6 files changed, 6 insertions(+), 7 deletions(-) diff --git a/website/docs/configuration/debug-prompt.md b/website/docs/configuration/debug-prompt.md index c3550856..c363f769 100644 --- a/website/docs/configuration/debug-prompt.md +++ b/website/docs/configuration/debug-prompt.md @@ -11,7 +11,7 @@ This feature only works in `powershell` for the time being. The debug prompt is displayed when you debug a script from the command line or Visual Studio Code. The default is `[DBG]: `. -You can use go [text/template][go-text-template] templates extended with [sprig][sprig] to enrich the text. +You can use go [text/template][go-text-template] [templates][templates] extended with [sprig][sprig] to enrich the text. Environment variables are available, just like the [`console_title_template`][console-title] functionality. ## Configuration @@ -38,7 +38,7 @@ The configuration has the following properties: - foreground_templates: foreground [color templates][color-templates] - background: `string` [color][colors] - background_templates: background [color templates][color-templates] -- template: `string` - A go [text/template][go-text-template] template extended with [sprig][sprig] utilizing the +- template: `string` - a go [text/template][go-text-template] template extended with [sprig][sprig] utilizing the properties below - defaults to `[DBG]: ` ## Template ([info][templates]) diff --git a/website/docs/configuration/line-error.md b/website/docs/configuration/line-error.md index 7cd91a2c..b21b5c2f 100644 --- a/website/docs/configuration/line-error.md +++ b/website/docs/configuration/line-error.md @@ -49,7 +49,7 @@ The configuration has the following properties: - background: `string` [color][colors] - foreground: `string` [color][colors] -- template: `string` - A go [text/template][go-text-template] template extended with [sprig][sprig] utilizing the +- template: `string` - a go [text/template][go-text-template] template extended with [sprig][sprig] utilizing the properties below - defaults to ` ` ## Template ([info][templates]) diff --git a/website/docs/configuration/secondary-prompt.md b/website/docs/configuration/secondary-prompt.md index 41de96a5..40021c62 100644 --- a/website/docs/configuration/secondary-prompt.md +++ b/website/docs/configuration/secondary-prompt.md @@ -35,7 +35,7 @@ The configuration has the following properties: - background: `string` [color][colors] - foreground: `string` [color][colors] -- template: `string` - A go [text/template][go-text-template] template extended with [sprig][sprig] utilizing the +- template: `string` - a go [text/template][go-text-template] template extended with [sprig][sprig] utilizing the properties below - defaults to `> ` ## Template ([info][templates]) diff --git a/website/docs/configuration/segment.md b/website/docs/configuration/segment.md index 787976c3..6bab0976 100644 --- a/website/docs/configuration/segment.md +++ b/website/docs/configuration/segment.md @@ -38,7 +38,7 @@ understand how to configure a segment. - invert_powerline: `boolean` - leading_diamond: `string` - trailing_diamond: `string` -- template: `string` a go text/template [template][templates] to render the prompt +- template: `string` a go [text/template][go-text-template] [template][templates] to render the prompt - foreground: `string` [color][colors] - foreground_templates: foreground [color templates][color-templates] - background: `string` [color][colors] diff --git a/website/docs/configuration/title.md b/website/docs/configuration/title.md index e90eae21..dc372c38 100644 --- a/website/docs/configuration/title.md +++ b/website/docs/configuration/title.md @@ -34,6 +34,5 @@ To learn more about templates and their possibilities, have a look at the [templ } ``` -[go-text-template]: https://golang.org/pkg/text/template/ [sprig]: https://masterminds.github.io/sprig/ [templates]: /docs/configuration/templates diff --git a/website/docs/configuration/transient.mdx b/website/docs/configuration/transient.mdx index c73fbe29..691264de 100644 --- a/website/docs/configuration/transient.mdx +++ b/website/docs/configuration/transient.mdx @@ -48,7 +48,7 @@ The configuration has the following properties: - foreground_templates: foreground [color templates][color-templates] - background: `string` [color][colors] - background_templates: background [color templates][color-templates] -- template: `string` - A go [text/template][go-text-template] template extended with [sprig][sprig] utilizing the +- template: `string` - a go [text/template][go-text-template] template extended with [sprig][sprig] utilizing the properties below - defaults to `{{ .Shell }}> ` ## Template ([info][templates])