Improve docs (#60)

* switch theme Signed-off-by: Flipez <code@brauser.io> * update generator Signed-off-by: Flipez <code@brauser.io> * fix path and style Signed-off-by: Flipez <code@brauser.io> * change base url Signed-off-by: Flipez <code@brauser.io> * improve file docs Signed-off-by: Flipez <code@brauser.io> * improve file docs Signed-off-by: Flipez <code@brauser.io> * Add header Signed-off-by: Flipez <code@brauser.io>
Flipez · Jan 19, 2022 · 4e1595a · 4e1595a · vercel · Jan 19, 2022
1 parent 3f222ed
commit 4e1595a
Show file tree

Hide file tree

Showing 18 changed files with 23 additions and 5 deletions.
diff --git a/docs/content/docs/control_expressions/foreach.md b/docs/content/docs/control_expressions/foreach.md
@@ -4,6 +4,7 @@ menu:
   docs:
     parent: "controls"
 ---
+# Foreach
 For loops allow to iterate over different sets of data and perform actions based on them.
 
 ```js

diff --git a/docs/content/docs/control_expressions/if.md b/docs/content/docs/control_expressions/if.md
@@ -4,6 +4,7 @@ menu:
   docs:
     parent: "controls"
 ---
+# If
 With `if` and `else` keywords the flow of a program can be controlled.
 
 ```js

diff --git a/docs/content/docs/literals/array.md b/docs/content/docs/literals/array.md
@@ -4,6 +4,7 @@ menu:
   docs:
     parent: "literals"
 ---
+# Array
 
 
 

diff --git a/docs/content/docs/literals/boolean.md b/docs/content/docs/literals/boolean.md
@@ -4,6 +4,7 @@ menu:
   docs:
     parent: "literals"
 ---
+# Boolean
 
 A Boolean can represent two values: `true` and `false` and can be used in control flows.
 

diff --git a/docs/content/docs/literals/error.md b/docs/content/docs/literals/error.md
@@ -4,6 +4,7 @@ menu:
   docs:
     parent: "literals"
 ---
+# Error
 
 
 

diff --git a/docs/content/docs/literals/file.md b/docs/content/docs/literals/file.md
@@ -4,6 +4,7 @@ menu:
   docs:
     parent: "literals"
 ---
+# File
 
 
 

diff --git a/docs/content/docs/literals/float.md b/docs/content/docs/literals/float.md
@@ -4,6 +4,7 @@ menu:
   docs:
     parent: "literals"
 ---
+# Float
 
 
 

diff --git a/docs/content/docs/literals/hash.md b/docs/content/docs/literals/hash.md
@@ -4,6 +4,7 @@ menu:
   docs:
     parent: "literals"
 ---
+# Hash
 
 
 

diff --git a/docs/content/docs/literals/integer.md b/docs/content/docs/literals/integer.md
@@ -4,6 +4,7 @@ menu:
   docs:
     parent: "literals"
 ---
+# Integer
 
 An integer can be positiv or negative and is always internally represented by a 64-Bit Integer.
 

diff --git a/docs/content/docs/literals/null.md b/docs/content/docs/literals/null.md
@@ -4,6 +4,7 @@ menu:
   docs:
     parent: "literals"
 ---
+# Null
 
 
 

diff --git a/docs/content/docs/literals/string.md b/docs/content/docs/literals/string.md
@@ -4,6 +4,7 @@ menu:
   docs:
     parent: "literals"
 ---
+# String
 
 
 

diff --git a/docs/content/docs/specification/builtins.md b/docs/content/docs/specification/builtins.md
@@ -5,7 +5,8 @@ menu:
     parent: "specification"
 toc: true
 ---
-### exit(INTEGER)
+# Builtin Functions
+## exit(INTEGER)
 
 Terminates the program with the given exit code.
 
@@ -14,7 +15,7 @@ Terminates the program with the given exit code.
 exit status 1
 ```
 
-### raise(INTEGER, STRING)
+## raise(INTEGER, STRING)
 
 Terminates the program with the given exit code and prints the error message.
 
@@ -24,7 +25,7 @@ Terminates the program with the given exit code and prints the error message.
 exit status 1
 ```
 
-### puts(STRING|ARRAY|HASH|BOOLEAN|INTEGER|NULL|FILE)
+## puts(STRING|ARRAY|HASH|BOOLEAN|INTEGER|NULL|FILE)
 
 Prints the string representation of the given object to STDOUT.
 
@@ -39,7 +40,7 @@ Prints the string representation of the given object to STDOUT.
 ["test", true, 3]
 ```
 
-### open(STRING, STRING, STRING)
+## open(STRING, STRING, STRING)
 > Returns FILE
 
 Opens a file pointer to the file at the path of argument one with the mode of (optional) argument two and a file permission as optional argument three.

diff --git a/docs/content/docs/specification/closures.md b/docs/content/docs/specification/closures.md
@@ -5,6 +5,7 @@ menu:
     parent: "specification"
 toc: true
 ---
+# Closures
 ```js
 newGreeter = def (greeting) {
   return def (name) { puts(greeting + " " + name); }

diff --git a/docs/content/docs/specification/comments.md b/docs/content/docs/specification/comments.md
@@ -5,6 +5,7 @@ menu:
     parent: "specification"
 toc: true
 ---
+# Comments
 Comments start with `//` characters.
 All following content up to the end of the line is part of the comment.
 

diff --git a/docs/content/docs/specification/functions.md b/docs/content/docs/specification/functions.md
@@ -1,10 +1,11 @@
 ---
-title: "Function"
+title: "Functions"
 menu:
   docs:
     parent: "specification"
 toc: true
 ---
+# Functions
 Implicit and explicit return statements are supported.
 
 ```js

diff --git a/docs/content/docs/specification/local_variables.md b/docs/content/docs/specification/local_variables.md
@@ -5,6 +5,7 @@ menu:
     parent: "specification"
 toc: true
 ---
+# Local Variables
 Variables represent the object as a memorable name.
 
 ```js

diff --git a/docs/content/docs/specification/modules.md b/docs/content/docs/specification/modules.md
@@ -5,6 +5,7 @@ menu:
     parent: "specification"
 toc: true
 ---
+# Modules
 > 👉 Modules were introduced in `0.11`
 
 Modules are seperate RocketLang files can be imported using the `import` statement.

diff --git a/docs/templates/literal.md b/docs/templates/literal.md
@@ -4,6 +4,7 @@ menu:
   docs:
     parent: "literals"
 ---
+# {{ .Title }}
 
 {{ .Description }}