Skip to content

Latest commit

 

History

History
74 lines (52 loc) · 1.91 KB

README.md

File metadata and controls

74 lines (52 loc) · 1.91 KB
Raw

Nuxt Scroll Spy Composable

npm version npm downloads License Nuxt

Nuxt module for @aleios10/vue3-scroll-spy-composable

Quick Setup

  1. Add @aleios10/nuxt-scroll-spy-composable dependency to your project
# Using pnpm
pnpm add -D @aleios10/nuxt-scroll-spy-composable

# Using yarn
yarn add --dev @aleios10/nuxt-scroll-spy-composable

# Using npm
npm install --save-dev @aleios10/nuxt-scroll-spy-composable
  1. Add @aleios10/nuxt-scroll-spy-composable to the modules section of nuxt.config.ts
export default defineNuxtConfig({
  modules: [
    '@aleios10/nuxt-scroll-spy-composable'
  ]
})

Development

# Install dependencies
npm install

# Generate type stubs
npm run dev:prepare

# Develop with the playground
npm run dev

# Build the playground
npm run dev:build

# Run ESLint
npm run lint

# Run Vitest
npm run test
npm run test:watch

# Release new version
npm run release