# nuxt-site-config

> Shared site configuration for Nuxt modules.

Latest version **5.0.3** (published 2026-10-13) · MIT license · 0 weekly downloads

## Install

```sh
npm install nuxt-site-config
pnpm add nuxt-site-config
yarn add nuxt-site-config
bun add nuxt-site-config
```

## Health

**Score 65/100 (B)** — status: active.

Positive: esm support; no vulnerabilities; has provenance; recently updated; high maintenance score.

Warnings: low downloads; no types.

## Facts

| | |
|---|---|
| Version | 5.0.3 |
| Published | 2026-10-13 |
| First published | 2023-05-26 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Node | ^22.22.3 \|\| ^24.15.0 \|\| >=26.0.0 |
| Dependencies | 8 |
| Unpacked size | 61.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Provenance | attested (GitHub Actions) |
| GitHub stars | 79 |
| Author | Harlan Wilton |
| Maintainers | harlan_zw |

## Links

- npm: https://www.npmjs.com/package/nuxt-site-config
- Repository: https://github.com/harlan-zw/nuxt-site-config
- Homepage: https://github.com/harlan-zw/nuxt-site-config#readme
- Issues: https://github.com/harlan-zw/nuxt-site-config/issues
- Funding: https://github.com/sponsors/harlan-zw
- npm.io page: https://npm.io/package/nuxt-site-config

## Dependencies (8)

- [ufo](https://npm.io/package/ufo.md) ^1.6.4
- [defu](https://npm.io/package/defu.md) ^6.1.7
- [consola](https://npm.io/package/consola.md) ^3.4.2
- [@nuxt/kit](https://npm.io/package/@nuxt/kit.md) ^4.6.0
- [@nuxt/devalue](https://npm.io/package/@nuxt/devalue.md) ^2.0.2
- [nuxtseo-shared](https://npm.io/package/nuxtseo-shared.md) ^6.0.0
- [site-config-stack](https://npm.io/package/site-config-stack.md) 5.0.3
- [nuxt-site-config-kit](https://npm.io/package/nuxt-site-config-kit.md) 5.0.3

## Recent versions

- 5.0.3 (latest) — 2026-10-13
- 0.1.1 (beta) — 2023-05-29
- 5.0.2 — 2026-10-13
- 5.0.1 — 2026-10-12
- 5.0.0 — 2026-10-12
- 4.2.3 — 2026-08-16
- 4.2.2 — 2026-08-11
- 4.2.1 — 2026-08-10
- 4.2.0 — 2026-08-06
- 4.1.5 — 2026-08-04
- 4.1.4 — 2026-08-03
- 4.1.3 — 2026-08-03
- 4.1.2 — 2026-07-19
- 4.1.1 — 2026-06-25
- 4.1.0 — 2026-06-11
- … 145 more at https://npm.io/package/nuxt-site-config/versions

## README

<h1><a href="https://nuxtseo.com"><img src=".github/assets/icon.svg" width="40" height="40" alt="Nuxt SEO" align="top"></a> nuxt-site-config</h1>

[![npm version][npm-version-src]][npm-version-href]
[![npm downloads][npm-downloads-src]][npm-downloads-href]
[![License][license-src]][license-href]
[![Nuxt][nuxt-src]][nuxt-href]
[![Skill repository on skilld.dev][skilld-src]][skilld-href]

Nuxt Site Config is a module for module authors to share common site config across modules.

Module authors consume it to provide a common site config API; end users typically interact with it through other modules.

<p align="center">
<table>
<tbody>
<td align="center">
<sub>Made possible by my <a href="https://github.com/sponsors/harlan-zw">Sponsor Program 💖</a><br> Follow me <a href="https://twitter.com/harlan_zw">@harlan_zw</a> 🐦 • Join <a href="https://discord.gg/275MBUBvgP">Discord</a> for help</sub><br>
</td>
</tbody>
</table>
</p>

## Features

- 😌 Zero-config, best practice site config defaults
- 🎨 Site config from any source: Nuxt Config, Environment Variables or Programmatically
- 🚀 Powerful and runtime agnostic APIs for module authors `useSiteConfig`, `createSitePathResolver`, `withSiteUrl`, `useNitroOrigin`, etc
- 🤖 Ledger capabilities
- 🤝 Integrates with `@nuxtjs/i18n`

## Installation

Install `nuxt-site-config` dependency to your project:

```bash
npx nuxt module add nuxt-site-config
```

> [!TIP]
> Using an AI agent? Get the nuxt-site-config Skill on [skilld.dev/gh/harlan-zw/nuxt-site-config](https://skilld.dev/gh/harlan-zw/nuxt-site-config).

## Documentation

[📖 Read the full documentation](https://nuxtseo.com/site-config) for more information.

## License

Licensed under the [MIT license](https://github.com/harlan-zw/nuxt-site-config/blob/main/LICENSE.md).

<!-- Badges -->
[npm-version-src]: https://img.shields.io/npm/v/nuxt-site-config/latest.svg?style=flat&labelColor=16152b&color=00a63e
[npm-version-href]: https://npmjs.com/package/nuxt-site-config

[npm-downloads-src]: https://img.shields.io/npm/dm/nuxt-site-config.svg?style=flat&labelColor=16152b&color=00a63e
[npm-downloads-href]: https://npmjs.com/package/nuxt-site-config

[license-src]: https://img.shields.io/github/license/harlan-zw/nuxt-site-config.svg?style=flat&labelColor=16152b&color=00a63e
[license-href]: https://github.com/harlan-zw/nuxt-site-config/blob/main/LICENSE.md

[nuxt-src]: https://img.shields.io/badge/Nuxt-16152b?logo=nuxt&style=flat
[nuxt-href]: https://nuxt.com

[skilld-src]: https://skilld.dev/b/harlan-zw/nuxt-site-config?style=flat&labelColor=16152b&color=00a63e&logoColor=ffffff
[skilld-href]: https://skilld.dev/gh/harlan-zw/nuxt-site-config

---
_Source: https://npm.io/package/nuxt-site-config · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
