From 07a422410611d22360dafccc0cb880ccc13d44d9 Mon Sep 17 00:00:00 2001 From: DebuggingMax Date: Sat, 28 Feb 2026 19:39:07 +0000 Subject: [PATCH] feat: Add GitHub Pages deployment for live demo - Add GitHub Actions workflow to deploy index.html to GitHub Pages - Update README with live demo link badge - Users can now preview the SocialShareButton without cloning the repo Fixes #31 --- .github/workflows/deploy-pages.yml | 38 ++++++++++++++++++++++++++++++ README.md | 11 +++++---- 2 files changed, 45 insertions(+), 4 deletions(-) create mode 100644 .github/workflows/deploy-pages.yml diff --git a/.github/workflows/deploy-pages.yml b/.github/workflows/deploy-pages.yml new file mode 100644 index 0000000..0d942a8 --- /dev/null +++ b/.github/workflows/deploy-pages.yml @@ -0,0 +1,38 @@ +# Deploy index.html demo to GitHub Pages +name: Deploy Demo to GitHub Pages + +on: + push: + branches: [main] + workflow_dispatch: + +permissions: + contents: read + pages: write + id-token: write + +concurrency: + group: "pages" + cancel-in-progress: false + +jobs: + deploy: + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@v4 + + - name: Setup Pages + uses: actions/configure-pages@v5 + + - name: Upload artifact + uses: actions/upload-pages-artifact@v3 + with: + path: '.' + + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v4 diff --git a/README.md b/README.md index 8345a7b..57d46b5 100644 --- a/README.md +++ b/README.md @@ -12,9 +12,9 @@
-[![Static Badge](https://img.shields.io/badge/AOSSIE-Social_Share_Button-228B22?style=for-the-badge&labelColor=FFC517)](https://TODO.aossie/) +[![Static Badge](https://img.shields.io/badge/AOSSIE-Social_Share_Button-228B22?style=for-the-badge&labelColor=FFC517)](https://aossie-org.github.io/SocialShareButton/) - +[![Live Demo](https://img.shields.io/badge/🚀_Live_Demo-Click_Here-blue?style=for-the-badge)](https://aossie-org.github.io/SocialShareButton/)
@@ -655,8 +655,11 @@ new SocialShareButton({ ## Demo -Open `index.html` in your browser to see all features. -Tutorial: https://youtu.be/cLJaT-8rEvQ?si=CLipA0Db4WL0EqKM +🚀 **[Live Demo](https://aossie-org.github.io/SocialShareButton/)** - Try it now without cloning! + +Or open `index.html` locally in your browser to see all features. + +📺 Tutorial: https://youtu.be/cLJaT-8rEvQ?si=CLipA0Db4WL0EqKM ---