Add Docs::Variables in README

adityatelange · Apr 28, 2023 · 4b83496 · 4b83496
1 parent e2640bf
commit 4b83496
Showing 1 changed file with 15 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -3,3 +3,18 @@
 <p align="center">
 <kbd><img src="https://user-images.githubusercontent.com/21258296/233713549-07016736-3ca1-46a3-895f-9c08b6cd9145.png" alt="Mockup image" title="Mockup" credits="https://screely.com/"/></kbd>
 </p>
+
+---
+
+## Docs
+
+### Variables
+
+| Variable                | Value                    | Description |
+| ----------------------- | ------------------------ | ----------- |
+| `showDescriptioninHome` | `true`                   |             |
+| `hideAllTagsinHome`     | `true`                   |             |
+| `searchBoxPlaceholder`  | `Type here to search...` |             |
+| `headers.key`           | `Title`                  |             |
+| `headers.value`         | `Tags`                   |             |
+| `permalinks.tags`       | `@:slug`                 |             |