1.0.3 • Published 9 months ago
nuxt-carbonbadge v1.0.3
Nuxt-CarbonBadge
Website Carbon compatibility and easy installation to find out how much carbon footprint your website.
Features ✨
- Nuxt 3 ready
- 🌑 Dark and 🌕 Light mode
Quick Setup
- Add
nuxt-carbonbadge
dependency to your project
# Using pnpm
pnpm add -D nuxt-carbonbadge
# Using yarn
yarn add --dev nuxt-carbonbadge
# Using npm
npm install --save-dev nuxt-carbonbadge
- Add
nuxt-carbonbadge
to themodules
section ofnuxt.config.ts
export default defineNuxtConfig({
modules: [
'nuxt-carbonbadge'
]
})
Usage 👌
Props:
darkMode
: Change Dark Mode or Light Mode (default:false
)
<CarbonBadge />
<template>
<footer>
<CarbonBadge />
</footer>
</template>
That's it! You can now use Nuxt-CarbonBadge in your Nuxt app ✨
Contributing 🙏
- Clone this repository
- Install dependencies using
pnpm install
(installpnpm
withcorepack enable
, learn more) - Run
npm run dev:prepare
to generate type stubs. - Use
npm run dev
to start playground in development mode.