From 9acc88803fc770e24b8c0f5a811da23d4e574195 Mon Sep 17 00:00:00 2001 From: Litruv Date: Sun, 9 Feb 2025 20:32:19 +1100 Subject: [PATCH] add additional author info section to README --- README.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/README.md b/README.md index 0e67b00..571d439 100644 --- a/README.md +++ b/README.md @@ -122,6 +122,29 @@ 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 | +## Additional Author Info + +You can add an "author" object in your `index.json` to display your name, role, and social links: + +```json +"author": { + "name": "Litruv", + "role": "Dev/Tech Artist @MatesMedia", + "socials": [ + { + "icon": "fab fa-github", + "url": "https://github.com/Litruv", + "title": "GitHub - Litruv" + }, + { + "icon": "fab fa-youtube", + "url": "https://www.youtube.com/c/Litruv", + "title": "YouTube - Litruv" + } + ] +} +``` + ## Technology Stack Built with modern web technologies and carefully selected dependencies: