From ec0e1b7f9e31d33876369d98347a64bb3ffa17ba Mon Sep 17 00:00:00 2001
From: Lukas Frey <mail@lukasfrey.cz>
Date: Sat, 3 Aug 2024 17:35:29 +0200
Subject: [PATCH] update docs

Signed-off-by: Lukas Frey <mail@lukasfrey.cz>
---
 README.md | 53 +++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 53 insertions(+)

diff --git a/README.md b/README.md
index 45e34cd..301fa73 100644
--- a/README.md
+++ b/README.md
@@ -207,6 +207,59 @@ icon: heroicon-o-book-open
 ---
 ```
 
+#### Front Matter Options
+Below is a list of currently available options in the front matter.
+
+#### Title
+Allows you to modify the title of the documentation page.
+```md
+---
+title: My new title
+---
+```
+
+#### Icon
+Allows you to modify the icon of the documentation page.
+
+You can use any name supported by Blade UI icons, that you have installed.
+
+```md
+---
+icon: heroicon-o-user
+---
+```
+
+#### Order
+Allows you to modify the order of the documentation page within it's parent / group.
+
+A lower number will be displayed first.
+
+```md
+---
+order: 1
+---
+```
+
+#### Group
+Allows you to define the group (and it's title) of the documentation page.
+
+```md
+---
+group: Getting Started
+---
+```
+
+#### Parent
+Allows you to define the parent of the documentation page.
+
+```md
+---
+parent: my-parent
+---
+```
+
+So for a file in `docs/en/prologue/getting-started/intro.md`, the parent would be `getting-started`.
+
 #### Content
 
 Anything after the front matter is your content, written in markdown: