Unifying site config with powerful and flexible APIs, for module authors and users.
|
Status: Released Please report any issues 🐛 Made possible by my Sponsor Program 💖 Follow me @harlan_zw 🐦 • Join Discord for help |
Site config can be considered config that is commonly used amongst modules but is not supported by the Nuxt core.
For example: url (canonical), name, description, indexable, trailingSlash, titleSeperator, etc.
Without a single source of truth for these, modules have a hard time working together and end-users have to duplicate config across modules.
Nuxt Site Config aims to fix this.
The end goal is to make it possible to build SEO multilingual / multi-tenancy sites that just work with modules.
- 😌 Zero-config, best practice site config defaults
- 🎨 Site config from any source: Nuxt Config, Runtime Config, Environment Variables, App Config, Route Rules or Programmatically
- 🚀 Powerful and runtime agnostic APIs for module authors
useSiteConfig,createSitePathResolver,withSiteUrl,useNitroOrigin, etc - 🤖 Ledger capabilities
- ✅ Safe fallbacks with runtime assertions (wip)
- 🏠 Build Multi-lingual Multi-tenancy sites (soon)
📖 Read the full documentation for more information.
MIT License © 2023-PRESENT Harlan Wilton