nuxt-gpt-content v0.4.0

Nuxt GPT Content

A Nuxt Content module capable of enhancing content creation via GPT APIs by querying a variety of models. Write content in your content files and include prompts that will be sent to Large Language Models (LLMs) such as OpenAI's GPT to generate and augment your content in order to quickly release new pages, posts, and any type of content you wish to manage.

• ✨  Release Notes

Features

• 📃 Support for Markdown files and Front-Matter variables and prompts
• 🤖 Support for OpenAI models such as GPT3.5 and GPT4
• 🚀 Direct integration within Nuxt Content ^2.0.0 and Nuxt ^3.0.0 projects

Quick Setup

1. Add nuxt-gpt-content dependency to your project

# Using pnpm
pnpm add -D nuxt-gpt-content

# Using yarn
yarn add --dev nuxt-gpt-content

# Using npm
npm install --save-dev nuxt-gpt-content

2. Add nuxt-gpt-content to the modules section of nuxt.config.ts

export default defineNuxtConfig({
  modules: [
    'nuxt-gpt-content'
  ]
})

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

Configuration

1. Add a gpt-content configuration object to your nuxt.config.ts file

   export default defineNuxtConfig({
   gptcontent: {
       active: true, //True by default but can be turned off
       contentModelProvider: 'openai', //`openai` or `none` for testing
       contentModelName: 'gpt-3.5-turbo', //Any supported OpenAI model name
       contentModelOptions: { //Any supported parameters to pass to the model config
           temperature: 0.8,
           n: 1,
           max_tokens: 250
       },
       commitHook: true, //Boolean or object containing commit details. Used to verify if a commit hook run after content files have been modified.
       saveContent: false //Should content files be updated and saved locally?
   },
   })

2. Ensure a you set an environment variable named NUXT_OPENAI_API_KEY with the value of you OpenAI API key.

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

License

MIT License