Install Nuxt Site Config · Nuxt Site Config

Nuxt Site Config is a module for Nuxt modules. While you can install it in your own project, it's recommended to use it in a module.

Install nuxt-site-config dependency to your project:

pnpm i -D nuxt-site-config nuxt-site-config-kit

Use the install function in your module:

modules.ts

import { installNuxtSiteConfig, updateSiteConfig } from 'nuxt-site-config-kit'

export default defineNuxtModule({
  // ...
  async setup(options) {
    await installNuxtSiteConfig()

    // Optional: set some site config from your modules options
    // This is not recommended, only to keep supporting your modules options
    updateSiteConfig({
      _context: 'my-module',
      url: options.siteUrl,
    })
  }
})

That's it! Explore the documentation to learn more.

What is Site Config?

Learn about the motivation behind Nuxt Site Config and a bit about how it works.

How it works

Learn how the Nuxt Site Config module works, so you can get the most out of it.