Skyost / NuxtCnameGenerator

A Github Pages CNAME generator for Nuxt applications.

NuxtCnameGenerator

A Github Pages CNAME generator for Nuxt applications.

Usage

First, add nuxt-cname-generator dependency to your project.

# Using pnpm.
pnpm add -D nuxt-cname-generator

# Using yarn.
yarn add --dev nuxt-cname-generator

# Using npm.
npm install --save-dev nuxt-cname-generator

Then, add nuxt-cname-generator to the modules section of nuxt.config.ts.

export default defineNuxtConfig({
  modules: [
    // Some other modules.
    'nuxt-cname-generator'
  ]
})

Finally, configure it in your nuxt.config.ts.

export default defineNuxtConfig({
  // Other config options.
  cname: {
    host: 'example.com'
  }
})

That's it ! Your CNAME will be available in the dist folder when you will run nuxi generate.

License

Licensed under the MIT license. See here.