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

add metadata configuration section to README and example JSON

Browse Source
This commit is contained in:
Litruv
2025-02-10 00:23:15 +11:00
parent 62751e141c
commit cf962c245f
2 changed files with 49 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
README.md
View File

@@ -122,6 +122,32 @@ Folders can contain nested documents or subfolders. Mark a folder by setting `"t
| `defaultOpen` | boolean? | Automatically expand this folder in the sidebar |
| `icon` | string? | Custom Font Awesome classes |
## Metadata Configuration
You can include a "metadata" object in `index.json` to provide:
- Site-wide title and short description
- Thumbnail for social sharing
- Display name for your site
```json
"metadata": {
"title": "Litruv / Documentation",
"description": "Documentation for Litruv's plugins",
"thumbnail": "img/og-image.png",
"site_name": "Litruv"
}
```
#### Metadata Configuration Options
| Option | Type | Description |
|---------------|--------|----------------------------------------------------------|
| `title` | string | Title of your documentation site |
| `description` | string | Description of your documentation site |
| `thumbnail` | string | URL to a thumbnail image for social sharing |
| `site_name` | string | Display name for your site |
## Additional Author Info
You can add an "author" object in your `index.json` to display your name, role, and social links: