https://github.com/harlan-zw/nuxt-site-config
Unifying site config with powerful and flexible APIs, for module authors and users.
https://github.com/harlan-zw/nuxt-site-config
Last synced: 5 months ago
JSON representation
Unifying site config with powerful and flexible APIs, for module authors and users.
- Host: GitHub
- URL: https://github.com/harlan-zw/nuxt-site-config
- Owner: harlan-zw
- License: mit
- Created: 2023-05-28T11:08:43.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-05-09T23:52:47.000Z (5 months ago)
- Last Synced: 2025-05-10T00:29:40.534Z (5 months ago)
- Language: TypeScript
- Homepage: https://nuxtseo.com/site-config
- Size: 2.27 MB
- Stars: 69
- Watchers: 2
- Forks: 11
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
- Security: SECURITY.md
Awesome Lists containing this project
README
nuxt-site-config
[![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]
Nuxt Site Config is a module for module authors to share common site config across modules.
It is not meant to be consumed by end-users directly, but rather to be used by module authors to provide a common site config API.
Made possible by my Sponsor Program 💖
Follow me @harlan_zw 🐦 • Join Discord for help
## 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`
## 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).
[npm-version-src]: https://img.shields.io/npm/v/nuxt-site-config/latest.svg?style=flat&colorA=18181B&colorB=28CF8D
[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&colorA=18181B&colorB=28CF8D
[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&colorA=18181B&colorB=28CF8D
[license-href]: https://github.com/harlan-zw/nuxt-site-config/blob/main/LICENSE.md
[nuxt-src]: https://img.shields.io/badge/Nuxt-18181B?logo=nuxt.js
[nuxt-href]: https://nuxt.com