-
-
Notifications
You must be signed in to change notification settings - Fork 41
Description
Overview
The SocialShareButton library currently lacks a dedicated marketing/showcase website, limiting its visibility and discoverability. This issue proposes building a minimal, SEO-optimised Next.js frontend that can be deployed for free using GitHub Pages (via static export).
The goal is to help developers discover the library quickly, understand its value, and integrate it with minimal friction.
implement all your changes targeted to "website" branch (not main).
Motivation
- Improve organic discoverability through search engines
- Demonstrate real-world usage and benefits to potential users
- Provide developers with a quick onboarding path
- Keep infrastructure simple — free hosting via GitHub Pages
Proposed Tech Stack
| Concern | Choice |
|---|---|
| Framework | Next.js (static export output: 'export') |
| Hosting | GitHub Pages (via GitHub Actions) |
| Styling | Tailwind CSS |
| SEO | next/head + Open Graph meta tags |
Required Sections
1. Hero Section
- Tagline: "Lightweight social share button library for modern websites"
- Sub-tagline highlighting ease of integration and zero dependencies
- Primary CTA buttons: Star on GitHub, View Docs, Try Demo
2. "Trusted By" / "Used In" Section
Display logos/links of organisations and projects that use or are affiliated with SocialShareButton:
3. "Why SocialShareButton?" Section (SEO + onboarding)
Short, benefit-focused highlights — not technical-heavy. Examples:
- 🚀 Lightweight & fast
- 🎨 Fully customisable styles
- ♿ Accessible by default
- 🔌 Drop-in integration — no build step required
- 📦 Framework agnostic
4. Real Use-Case Section
Showcase scenarios where the library shines (see #26 for reference):
- Blog posts & articles
- Documentation websites
- E-commerce product pages
- Web3 / DeFi applications with steps-based sharing flows
- Marketing landing pages
5. Quick Integration Example (Copy-Paste Snippet)
A syntax-highlighted, copy-to-clipboard code block showing the minimal integration (HTML <script> + <link> + button markup). Developers love quick onboarding — this section should answer "How do I add this in 30 seconds?"
Important: Always import the button CSS and JS from the existing library files — no duplication or additional bundling.
6. Animated Demo Preview
An interactive or animated section showing the social share buttons in action. Creative freedom is encouraged, but:
- Must source styles and behaviour from the existing
src/CSS and JS files - No extra third-party UI libraries just for the demo
7. Comparison Section
A simple table comparing SocialShareButton with alternative libraries (e.g., AddToAny, ShareThis, react-share) across dimensions like:
- Bundle size
- Customisability
- SSR compatibility
- Framework support
- Open-source / self-hosted
8. Footer CTAs
Sticky or prominent end-of-page buttons:
- ⭐ Star on GitHub
- 📖 View Docs
- 🎮 Try Demo
SEO Requirements
- Proper
<title>,<meta description>, Open Graph, and Twitter Card tags on every page - Semantic HTML5 structure
- Fast load times (static export = no server needed)
- Target keywords: "social share button library", "lightweight share buttons javascript", "open source social sharing"
Deployment
The site should be deployable via a GitHub Actions workflow that:
- Runs
next buildwithoutput: 'export' - Publishes the
out/directory to thegh-pagesbranch
Acceptance Criteria
- Next.js project bootstrapped with static export configured
- GitHub Actions workflow for automated deployment to GitHub Pages
- All 8 sections above implemented
- SEO meta tags in place on all pages
- Existing library CSS/JS imported — no duplication
- Responsive design (mobile + desktop)
- Lighthouse score ≥ 90 for Performance, SEO, and Accessibility
- Design preview (Figma or AI-generated mockup) shared before implementation begins
References
- Real use-cases discussion: [FEATURE]: Auto-generate Share Text Based on Content #26
- Library source:
src/social-share-button.js,src/social-share-button.css
Note for contributors: Please share a Figma file or AI-generated preview images in this issue before opening a PR, so the design can be reviewed and aligned with project goals early.