From 234e04e8be3a0f77fb05d59d7facfde56a4d5669 Mon Sep 17 00:00:00 2001 From: Litruv Date: Sun, 9 Feb 2025 19:35:50 +1100 Subject: [PATCH] added readme changes --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index 5bf0ca4..5ace7d7 100644 --- a/README.md +++ b/README.md @@ -50,6 +50,8 @@ Configure your documentation structure in `index.json`: ```json { + "title": "Your Documentation Title", + "defaultPage": "welcome", "documents": [ { "title": "Getting Started", @@ -59,6 +61,14 @@ Configure your documentation structure in `index.json`: } ``` +#### Root Configuration Options + +| Option | Type | Description | +|--------|------|-------------| +| `title` | string | The title of your documentation site | +| `defaultPage` | string | The slug of the page to show when no page is specified | +| `documents` | array | Array of document and folder objects | + ### Folder Organization Create hierarchical documentation structures with nested folders: