docs: added text type docs

gttp-cli · Feb 9, 2024 · 8472f4f · 8472f4f
1 parent f81c4a3
commit 8472f4f
Show file tree

Hide file tree

Showing 7 changed files with 58 additions and 12 deletions.
diff --git a/docs/getting-started/_category_.yml b/docs/getting-started/_category_.yml
@@ -1,3 +1,3 @@
-label: 🚀 Getting Started
+label: Getting Started
 position: 2
 collapsed: false
diff --git a/docs/getting-started/run-demo.md b/docs/getting-started/run-demo.md
@@ -25,7 +25,6 @@ template: |-
   {{ range .Users }}
   - {{ .Name }} is an admin: {{ .Admin }}
   {{ end }}
-
 ```
 
 This is a simple example of a GTTP template.  

diff --git a/docs/syntax/_category_.yml b/docs/syntax/_category_.yml
@@ -1,3 +1,3 @@
-label: ✍️ Syntax
+label: Syntax
 position: 2
 collapsed: false
diff --git a/docs/syntax/template.md b/docs/syntax/template.md
@@ -85,16 +85,16 @@ structures:
       description: Lastname of the person
 
 variables:
-    - name: UserA
-      type: person
-      description: A person
-    - name: UserB
-      type: person
-      description: Another person
+  - name: UserA
+    type: person
+    description: A person
+  - name: UserB
+    type: person
+    description: Another person
 
 template: |-
-    Hello, {{ .UserA.Name }} {{ .UserA.Lastname }}!
-    Hello, {{ .UserB.Name }} {{ .UserB.Lastname }}!
+  Hello, {{ .UserA.Name }} {{ .UserA.Lastname }}!
+  Hello, {{ .UserB.Name }} {{ .UserB.Lastname }}!
 ```
 
 When executing the template, GTTP will interactively ask you to fill out the defined variables:
@@ -107,7 +107,7 @@ When executing the template, GTTP will interactively ask you to fill out the def
 ```
 
 When all variables are filled out, GTTP will parse the template to:
-    
+
 ```
 Hello, John Doe!
 Hello, Jane Doe!

diff --git a/docs/syntax/types/number.md b/docs/syntax/types/number.md
@@ -0,0 +1 @@
+# Number
diff --git a/docs/syntax/types/number.yml b/docs/syntax/types/number.yml
diff --git a/docs/syntax/types/text.md b/docs/syntax/types/text.md
@@ -1 +1,47 @@
 # Text
+
+The `text` type can be used to define variables that accept text input.
+
+## Basic
+
+Basic syntax for the `text` type:
+
+```yaml
+variables:
+  - name: Name
+    type: text # Set the type to text
+    description: Name of the person
+template: |-
+  Hello, {{ .Name }}!
+```
+
+## Multiline
+
+You can use the `multiline` property to define a multiline text input:
+
+```yaml
+variables:
+  - name: Description
+    type: text
+    multiline: true # Set the multiline property to true
+    description: Description of the person
+template: |-
+  Description:
+  {{ .Description }}
+```
+
+## Validation
+
+### Regex
+
+You can use the `regex` property to define a regular expression for validation:
+
+```yaml
+variables:
+  - name: Text
+    type: text
+    regex: ^[a-z]+$ # only allow lowercase letters
+    description: A string of lowercase letters
+template: |-
+  {{ .Text }}
+```