Skip to content

Commit

Permalink
chore: setup
Browse files Browse the repository at this point in the history
  • Loading branch information
anubra266 committed Dec 24, 2024
1 parent c557135 commit 5761f7b
Show file tree
Hide file tree
Showing 3 changed files with 131 additions and 2 deletions.
20 changes: 20 additions & 0 deletions .github/composite-actions/install.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
name: "Install"
description: "Sets up Node.js and runs install"

runs:
using: composite
steps:
- uses: pnpm/[email protected]
with:
version: 7

- name: Setup Node.js
uses: actions/setup-node@v3
with:
node-version: 16.x
registry-url: "https://registry.npmjs.org"
cache: "pnpm"

- name: Install dependencies
shell: bash
run: pnpm install
59 changes: 59 additions & 0 deletions .github/workflows/static.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
# Simple workflow for deploying static content to GitHub Pages
name: Deploy Demo page

on:
# Runs on pushes targeting the default branch
push:
branches: ["main"]

# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:

# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: read
pages: write
id-token: write

# Allow one concurrent deployment
concurrency:
group: "pages"
cancel-in-progress: true

env:
BUILD_PATH: "site"

jobs:
build:
name: Build
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v3
- name: Install
uses: ./.github/composite-actions/install
- name: Setup Node
uses: actions/setup-node@v3
- name: Setup Pages
id: pages
uses: actions/configure-pages@v2
- name: Build with Vite
run: |
pnpm --filter site build
working-directory: ${{ env.BUILD_PATH }}
- name: Upload artifact
uses: actions/upload-pages-artifact@v1
with:
path: ${{ env.BUILD_PATH }}/site-build

deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
needs: build
runs-on: ubuntu-latest
name: Deploy
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v1
54 changes: 52 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,52 @@
# zag-scrollspy
Simple Agnostic Scrollspy
<div align="center">

<h1>
<br/>
📜
<br />
zag-scrollspy
<br />
<br />
</h1>
<sup>
<br />
<br />
<a href="https://www.npmjs.com/package/zag-scrollspy?style=for-the-badge">
<img src="https://img.shields.io/npm/v/zag-scrollspy.svg?style=for-the-badge" alt="npm package" />
</a>
<a href="https://www.npmjs.com/package/zag-scrollspy?style=for-the-badge">
<img src="https://img.shields.io/npm/dw/zag-scrollspy.svg?style=for-the-badge" alt="npm downloads" />
</a>
<a>
<img alt="NPM" src="https://img.shields.io/npm/l/zag-scrollspy?style=for-the-badge">
</a>

<a><img alt="GitHub Repo stars" src="https://img.shields.io/github/stars/anubra266/zag-scrollspy?logo=github&style=for-the-badge">

</a>
<br />
Simple Agnostic Scrollspy.

</sup>
<br />
<br />
<br />
<br />
<pre>npm i <a href="https://www.npmjs.com/package/zag-scrollspy">zag-scrollspy</a></pre>
<br />
<br />
<br />
<br />
<br />
</div>

## Install

```bash
npm i --save zag-scrollspy
#or
yarn add zag-scrollspy
#or
pnpm add zag-scrollspy
```

0 comments on commit 5761f7b

Please sign in to comment.