From 3de537ea8cecc297c282d9d2ca62efa7bd1122da Mon Sep 17 00:00:00 2001 From: Selena Goods Date: Fri, 10 Nov 2023 15:18:32 -0500 Subject: [PATCH] Add `.SchemaMarkdown` field and `printf` functions to Readme --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index bd7945b5..2fc6c6bc 100644 --- a/README.md +++ b/README.md @@ -146,6 +146,7 @@ using the following data fields and functions: | `.ProviderName` | string | Canonical provider name (ex. `terraform-provider-random`) | | `.ProviderShortName` | string | Short version of the provider name (ex. `random`) | | `.RenderedProviderName` | string | Value provided via argument `--rendered-provider-name`, otherwise same as `.ProviderName` | +| `.SchemaMarkdown` | string | a Markdown formatted Provider Schema definition | ##### Resources / Data Source @@ -161,6 +162,7 @@ using the following data fields and functions: | `.ProviderName` | string | Canonical provider name (ex. `terraform-provider-random`) | | `.ProviderShortName` | string | Short version of the provider name (ex. `random`) | | `.RenderedProviderName` | string | Value provided via argument `--rendered-provider-name`, otherwise same as `.ProviderName` | +| `.SchemaMarkdown` | string | a Markdown formatted Resource / Data Source Schema definition | #### Functions @@ -170,6 +172,7 @@ using the following data fields and functions: | `lower` | Equivalent to [`strings.ToLower`](https://pkg.go.dev/strings#ToLower). | | `plainmarkdown` | Render Markdown content as plaintext. | | `prefixlines` | Add a prefix to all (newline-separated) lines in a string. | +| `printf` | Equivalent to [`fmt.Printf`](https://pkg.go.dev/fmt#Printf). | | `split` | Split string into sub-strings, by a given separator (ex. `split .Name "_"`). | | `title` | Equivalent to [`cases.Title`](https://pkg.go.dev/golang.org/x/text/cases#Title). | | `tffile` | A special case of the `codefile` function, designed for Terraform files (i.e. `.tf`). |