{"id":51600937,"url":"https://github.com/gioxx/YOURLS-AlternativeIndex","last_synced_at":"2026-07-31T00:00:42.653Z","repository":{"id":361009716,"uuid":"1248380038","full_name":"gioxx/YOURLS-AlternativeIndex","owner":"gioxx","description":"Transform the unused YOURLS root page into a Linktree-style profile page with social links, featured content, and custom branding.","archived":false,"fork":false,"pushed_at":"2026-06-05T16:52:16.000Z","size":82,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-06-26T05:32:13.785Z","etag":null,"topics":["php","yourls","yourls-plugin"],"latest_commit_sha":null,"homepage":"https://yourls.gioxx.org/plugins/alternative-index","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/gioxx.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null},"funding":{"github":"gioxx","ko_fi":"gioxx","buy_me_a_coffee":"gioxx"}},"created_at":"2026-05-24T15:11:15.000Z","updated_at":"2026-06-05T16:52:18.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/gioxx/YOURLS-AlternativeIndex","commit_stats":null,"previous_names":["gioxx/yourls-alternativeindex"],"tags_count":5,"template":false,"template_full_name":null,"purl":"pkg:github/gioxx/YOURLS-AlternativeIndex","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gioxx%2FYOURLS-AlternativeIndex","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gioxx%2FYOURLS-AlternativeIndex/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gioxx%2FYOURLS-AlternativeIndex/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gioxx%2FYOURLS-AlternativeIndex/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/gioxx","download_url":"https://codeload.github.com/gioxx/YOURLS-AlternativeIndex/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gioxx%2FYOURLS-AlternativeIndex/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":36096156,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-07-20T02:08:10.276Z","status":"online","status_checked_at":"2026-07-30T02:00:05.956Z","response_time":106,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["php","yourls","yourls-plugin"],"created_at":"2026-07-11T22:00:32.914Z","updated_at":"2026-07-31T00:00:42.645Z","avatar_url":"https://github.com/gioxx.png","language":"PHP","funding_links":["https://github.com/sponsors/gioxx","https://ko-fi.com/gioxx","https://buymeacoffee.com/gioxx"],"categories":["Plugins"],"sub_categories":["A"],"readme":"# 🌐 YOURLS Alternative Index\n\n**Transform the unused YOURLS root page into a Linktree-style profile page with social links, featured content, and custom branding.**  \nInstead of showing a 403 error, visitors to your YOURLS root URL will see a beautiful, customizable link-in-bio page.\n\n[![Latest Release](https://img.shields.io/github/v/release/gioxx/YOURLS-AlternativeIndex)](https://github.com/gioxx/YOURLS-AlternativeIndex/releases)\n[![License](https://img.shields.io/github/license/gioxx/YOURLS-AlternativeIndex)](LICENSE)\n[![Listed in Awesome YOURLS!](https://img.shields.io/badge/Awesome-YOURLS-C5A3BE)](https://github.com/YOURLS/awesome)\n\n---\n\n## 🚀 Features\n\n- **Linktree-style profile page** served at your YOURLS root URL (`/`)\n- **Profile section**: display name, tagline/bio, avatar image\n- **Social icons row**: X/Twitter, Instagram, Facebook, LinkedIn, GitHub, YouTube, TikTok, Mastodon, Bluesky, Threads, Pinterest, Twitch, Discord, Telegram, WhatsApp, and more\n- **Featured link buttons**: full-width cards with optional emoji, title, and URL\n- **Custom colors**: background, accent (buttons \u0026 icon hover), and text colors\n- **Custom CSS**: inject your own styles for full control\n- **Enable/disable toggle**: turn the page on or off without deactivating the plugin\n- **Update notifications**: checks GitHub for new releases and shows a badge in the admin panel\n- **Simple single-file plugin** — no composer, no npm, no build step\n\n---\n\n## 🛠️ Installation\n\n1. Download the plugin from [the latest release](https://github.com/gioxx/YOURLS-AlternativeIndex/releases).\n2. Unzip the contents into the `user/plugins/alternative-index/` directory.\n3. Activate the plugin in the YOURLS admin panel under **Plugins**.\n4. Go to **Plugins → Alternative Index** and configure your page.\n\n\u003e **Requires YOURLS 1.9+ and PHP 7.4+**\n\n---\n\n## ⚙️ Usage\n\n### Basic Configuration\n\n1. Open the **Alternative Index** settings page from the Plugins menu.\n2. **Enable** the plugin using the toggle at the top.\n3. Fill in your **Profile**: name, tagline, and avatar URL.\n4. Choose your **Appearance**: background color, accent color, and text color.\n5. Add **Social Links**: select the platform and paste your profile URL.\n6. Add **Featured Links**: enter an optional emoji, a title, and a URL.\n7. Click **Save Settings** and visit your YOURLS root URL to see the result.\n\n### How it works\n\n| Visitor request | Result |\n|---|---|\n| YOURLS root URL (`/`) — plugin enabled | Shows the Alternative Index profile page |\n| YOURLS root URL (`/`) — plugin disabled | Default YOURLS behavior (403 / blank) |\n| Valid short URL (e.g. `/abc`) | YOURLS handles it normally |\n| Admin panel | Unaffected |\n| API / AJAX requests | Unaffected |\n\n### Supported social platforms\n\n| Platform | Key |\n|---|---|\n| Website / Blog | `website` |\n| Email | `email` |\n| GitHub | `github` |\n| X (Twitter) | `twitter` or `x` |\n| Instagram | `instagram` |\n| Facebook | `facebook` |\n| LinkedIn | `linkedin` |\n| YouTube | `youtube` |\n| TikTok | `tiktok` |\n| Mastodon | `mastodon` |\n| Bluesky | `bluesky` |\n| Threads | `threads` |\n| Pinterest | `pinterest` |\n| Twitch | `twitch` |\n| Discord | `discord` |\n| Telegram | `telegram` |\n| WhatsApp | `whatsapp` |\n\nAny other value will display a generic icon with the platform's initial letter.\n\n### Custom CSS examples\n\nTarget the main card container:\n```css\n.yai-card { backdrop-filter: blur(8px); }\n```\n\nMake link buttons square instead of pill-shaped:\n```css\n.yai-link { border-radius: 8px; }\n```\n\nUse a gradient background:\n```css\nbody { background: linear-gradient(135deg, #1a1a2e, #16213e, #0f3460); }\n```\n\n---\n\n## 🔧 Stored Options\n\n| Option key | Type | Notes |\n|---|---|---|\n| `yai_enabled` | int | `1` = active, `0` = disabled |\n| `yai_profile_name` | string | Display name |\n| `yai_tagline` | string | Short bio shown below the name |\n| `yai_avatar_url` | string | Full URL to profile image |\n| `yai_page_title` | string | Browser tab title; defaults to profile name |\n| `yai_bg_color` | string | Hex color for background |\n| `yai_accent_color` | string | Hex color for hover states and button fills |\n| `yai_text_color` | string | Hex color for all text |\n| `yai_card_transparency` | int | Card transparency percentage when a background image is active; `100` removes the glass effect; default `55` |\n| `yai_social_links` | JSON | Array of `{platform, url}` objects |\n| `yai_featured_links` | JSON | Array of `{emoji, title, url}` objects |\n| `yai_custom_css` | string | Raw CSS injected into the public page |\n| `yai_show_powered_by` | int | `1` = show footer attribution |\n\n---\n\n## ⚠️ Compatibility note\n\nThis plugin and [YOURLS URL Fallback](https://github.com/gioxx/YOURLS-URLFallback) both intercept the YOURLS root URL. If you have both active, **Alternative Index takes precedence** (it runs at priority 99 and serves a page directly — URL Fallback's redirect never fires for the root URL). Use one or the other for root URL handling.\n\n---\n\n## 📄 License\n\nThis plugin is licensed under the [MIT License](LICENSE).\n\n---\n\n## 💬 About\n\nLovingly developed by the usually-on-vacation brain cell of [Gioxx](https://github.com/gioxx).\n\n---\n\n## 🤝 Contributing\n\nPull requests and feature suggestions are welcome!  \nIf you find bugs or have feature requests, [open an issue](https://github.com/gioxx/YOURLS-AlternativeIndex/issues).  \nIf you find it useful, leave a ⭐ on GitHub! ❤️\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgioxx%2FYOURLS-AlternativeIndex","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgioxx%2FYOURLS-AlternativeIndex","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgioxx%2FYOURLS-AlternativeIndex/lists"}