litruv/Docs-Viewer
1
0
Fork 0
mirror of https://github.com/litruv/Docs-Viewer.git synced 2026-07-24 02:36:07 +10:00
Code Issues Packages Projects Releases Wiki Activity

added readme changes

Browse Source
This commit is contained in:
Litruv
2025-02-09 19:35:50 +11:00
parent 13a8d4ef48
commit 234e04e8be
1 changed files with 10 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@@ -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: