{"id":15063116,"url":"https://github.com/joepocalyptic/nuxt-builderio","last_synced_at":"2025-04-10T10:33:39.272Z","repository":{"id":190153836,"uuid":"682079638","full_name":"Joepocalyptic/nuxt-builderio","owner":"Joepocalyptic","description":"Quickly and easily integrate Builder.io as a visual CMS for your Nuxt application.","archived":false,"fork":false,"pushed_at":"2025-04-09T23:05:04.000Z","size":590,"stargazers_count":9,"open_issues_count":13,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-10T00:20:05.726Z","etag":null,"topics":["builderio","cms","headless-cms","nuxt","nuxt-module","nuxt-modules","nuxt3","page-builder"],"latest_commit_sha":null,"homepage":"https://nuxt-builderio.joeypereira.dev","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Joepocalyptic.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2023-08-23T11:50:58.000Z","updated_at":"2025-03-23T15:32:51.000Z","dependencies_parsed_at":"2023-12-25T21:23:02.889Z","dependency_job_id":"16fb4198-5e43-419b-a825-d2a728e81b63","html_url":"https://github.com/Joepocalyptic/nuxt-builderio","commit_stats":null,"previous_names":["joepocalyptic/nuxt-builderio"],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Joepocalyptic%2Fnuxt-builderio","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Joepocalyptic%2Fnuxt-builderio/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Joepocalyptic%2Fnuxt-builderio/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Joepocalyptic%2Fnuxt-builderio/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Joepocalyptic","download_url":"https://codeload.github.com/Joepocalyptic/nuxt-builderio/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248199244,"owners_count":21063641,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["builderio","cms","headless-cms","nuxt","nuxt-module","nuxt-modules","nuxt3","page-builder"],"created_at":"2024-09-24T23:51:39.723Z","updated_at":"2025-04-10T10:33:39.245Z","avatar_url":"https://github.com/Joepocalyptic.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Nuxt Builder.io Module\n\n[![npm version][npm-version-src]][npm-version-href]\n[![npm downloads][npm-downloads-src]][npm-downloads-href]\n[![License][license-src]][license-href]\n[![Nuxt][nuxt-src]][nuxt-href]\n\nThis is an unofficial Nuxt module for [Builder.io](https://builder.io/). It allows you to quickly and easily integrate\nBuilder.io as a visual CMS for your Nuxt application.\n\n**This module is currently in development.** It is not yet intended for production use and there will be bugs. Feel\nfree to help out by reporting bugs and submitting pull requests!\n\nFurthermore, this module uses Builder's [second-generation Vue SDK](https://www.npmjs.com/package/@builder.io/sdk-vue), which is currently in beta.\n\n- [📖 \u0026nbsp;Documentation](https://nuxt-builderio.joeypereira.dev)\n- [✨ \u0026nbsp;Release Notes](/CHANGELOG.md)\n- [🏀 Online playground](https://stackblitz.com/github/Joepocalyptic/nuxt-builderio?file=playground%2Fapp.vue)\n\n## Features\n\n- Built for **Nuxt 3**\n- Automatically register [custom components](https://www.builder.io/c/docs/custom-components-intro)\n- Opinionated defaults to get started with no configuration\n\n## Quick Setup\n\n1. Add the `nuxt-builderio` dependency to your project\n\n```bash\n# Using pnpm\npnpm add -D nuxt-builderio\n\n# Using yarn\nyarn add --dev nuxt-builderio\n\n# Using npm\nnpm install --save-dev nuxt-builderio\n```\n\n2. Add `nuxt-builderio` to the `modules` section of `nuxt.config.ts`\n\n```js\nexport default defineNuxtConfig({\n  modules: [\n    'nuxt-builderio'\n  ]\n})\n```\n\nThat's it! Read the [documentation](https://nuxt-builderio.joeypereira.dev) for more information, including\nconfiguration and optimization options.\n\nYou can get started extremely quickly by using the provided `BuilderContent` component in a page:\n\n```vue\n\u003ctemplate\u003e\n  \u003cBuilderContent\n    throw-error\n    @load=\"onContentLoaded\"\n  /\u003e\n\u003c/template\u003e\n\n\u003cscript setup lang=\"ts\"\u003e\n// You can directly access the content returned by Builder with the `@load` event\nconst onContentLoaded = (content) =\u003e {\n  console.log(content)\n}\n\u003c/script\u003e\n```\n\nThis will automatically render Builder content with full support for SSR. If no `path` is provided, it\nwill default to the current page's path. If no `model` is provided, it will use the `defaultModel` provided\nin the module options (this defaults to `page`).\n\nThe `throwError` prop will cause the component to throw a 404 error if the content is not found.\n\n## Development\n\n```bash\n# Install dependencies\npnpm install\n\n# Generate type stubs\npnpm run dev:prepare\n\n# Develop with the playground\npnpm run dev\n\n# Build the playground\npnpm run dev:build\n\n# Run ESLint\npnpm run lint\n\n# Release new version\npnpm run release\n```\n\n\u003c!-- Badges --\u003e\n[npm-version-src]: https://img.shields.io/npm/v/nuxt-builderio/latest.svg?style=flat\u0026colorA=18181B\u0026colorB=28CF8D\n[npm-version-href]: https://npmjs.com/package/nuxt-builderio\n\n[npm-downloads-src]: https://img.shields.io/npm/dm/nuxt-builderio.svg?style=flat\u0026colorA=18181B\u0026colorB=28CF8D\n[npm-downloads-href]: https://npmjs.com/package/nuxt-builderio\n\n[license-src]: https://img.shields.io/npm/l/nuxt-builderio.svg?style=flat\u0026colorA=18181B\u0026colorB=28CF8D\n[license-href]: https://npmjs.com/package/nuxt-builderio\n\n[nuxt-src]: https://img.shields.io/badge/Nuxt-18181B?logo=nuxt.js\n[nuxt-href]: https://nuxt.com\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjoepocalyptic%2Fnuxt-builderio","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjoepocalyptic%2Fnuxt-builderio","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjoepocalyptic%2Fnuxt-builderio/lists"}