Skip to content

StevenJPx2/nuxt-pagescms

Repository files navigation

Nuxt PagesCMS

npm version npm downloads License Nuxt

Nuxt integration of PagesCMS.

Features

  • 🥱 Zero config setup
  • 💪 Fully type safe usePagesFile and usePagesCollection
  • 🛡️ Auto-generated types for composables from .pages.yml
  • 🤗 Fully SSR and SSG friendly!

Usage

<script setup lang="ts">
const home = await usePagesFile("home"); // fully typed with only the files defined in .pages.yml

home; // fully typed based on the schema given in .pages.yml
</script>

Quick Setup

Install the module to your Nuxt application with one command:

npx nuxi module add nuxt-pagescms

That's it! You can now use Nuxt PagesCMS in your Nuxt app ✨

Contribution

Local development

# Install dependencies
npm install

# Generate type stubs
npm run dev:prepare

# Develop with the playground
npm run dev

# Build the playground
npm run dev:build

# Run ESLint
npm run lint

# Run Vitest
npm run test
npm run test:watch


# Release new version
npm run release

About

🦾 Use PagesCMS with confidence using Nuxt with type-safe composables.

Resources

License

Stars

Watchers

Forks

Packages

No packages published