nuxt-strapi-blocks-renderer 1.0.0 → 1.0.2

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) Frederik Bußmann
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,10 +1,15 @@
 # Nuxt Strapi Blocks Renderer
 
-A fully customizable Nuxt module for rendering the 'blocks' text element from Strapi CMS.
+[![Github Actions][github-actions-src]][github-actions-href]
+[![NPM version][npm-version-src]][npm-version-href]
+[![NPM downloads][npm-downloads-src]][npm-downloads-href]
+[![License][license-src]][license-href]
+
+A fully customizable Nuxt 3 module for rendering text with the new Blocks rich text editor element from Strapi CMS.
 
 ## Installation
 
-1. Install the npm package:
+1. Install the Blocks renderer:
 
     ```bash
     npm install nuxt-strapi-blocks-renderer
@@ -24,8 +29,8 @@ To render text, use the `StrapiBlocksText` component:
 <StrapiBlocksText :nodes="blockNodes" />
 ```
 
-In this example, the `blockNodes` are taken from the JSON response which Strapi provides when using the `blocks` text
-element:
+In this example, the `blockNodes` are taken from the JSON response which Strapi provides when using the Blocks rich
+text editor element:
 
 ```vue
 <script setup lang="ts">
@@ -47,6 +52,8 @@ element:
 </template>
 ```
 
+To use the `useStrapi` composable, install the [Strapi Nuxt module](https://strapi.nuxtjs.org/).
+
 ### Advanced Usage
 
 In situations where your project requires specific styling or behavior for certain HTML tags such as `<a>`, `<p>`,
@@ -88,6 +95,19 @@ To override the default paragraph tag, we create a file called `StrapiBlocksText
 
 This component assigns a custom class `my-custom-class-for-p` to the paragraph tag, which can be styled as needed.
 
+The prefix for the custom components can be adjusted in your `nuxt.config.{js|ts}`:
+
+```typescript
+modules: ['nuxt-strapi-blocks-renderer'],
+strapiBlocksRenderer: {
+    prefix: 'MyCustomPrefix'
+    blocksPrefix: 'MyCustomBlocksPrefix',
+},
+```
+
+With this configuration, the `StrapiBlocksText` component becomes `MyCustomPrefixStrapiBlocksText` and the custom
+paragraph node component would be named `MyCustomBlocksPrefixParagraphNode`.
+
 #### Other Custom Tags
 
 You can apply similar customizations to all other HTML tags used by the renderer.
@@ -273,3 +293,15 @@ npm run test
 # Release new version
 npm run release
 ```
+
+[github-actions-src]: https://github.com/freb97/nuxt-strapi-blocks-renderer/actions/workflows/ci.yml/badge.svg
+[github-actions-href]: https://github.com/freb97/nuxt-strapi-blocks-renderer/actions
+
+[npm-version-src]: https://img.shields.io/npm/v/nuxt-strapi-blocks-renderer/latest.svg?style=flat&colorA=18181B&colorB=31C553
+[npm-version-href]: https://npmjs.com/package/nuxt-strapi-blocks-renderer
+
+[npm-downloads-src]: https://img.shields.io/npm/dm/nuxt-strapi-blocks-renderer.svg?style=flat&colorA=18181B&colorB=31C553
+[npm-downloads-href]: https://npmjs.com/package/nuxt-strapi-blocks-renderer
+
+[license-src]: https://img.shields.io/github/license/freb97/nuxt-strapi-blocks-renderer.svg?style=flat&colorA=18181B&colorB=31C553
+[license-href]: https://github.com/freb97/nuxt-strapi-blocks-renderer/blob/main/LICENSE

package/dist/module.json

@@ -1,5 +1,5 @@
 {
   "name": "nuxt-strapi-blocks-renderer",
   "configKey": "strapiBlocksRenderer",
-  "version": "1.0.0"
+  "version": "1.0.2"
 }

package/package.json

@@ -1,8 +1,12 @@
 {
     "name": "nuxt-strapi-blocks-renderer",
-    "version": "1.0.0",
+    "version": "1.0.2",
     "description": "Renderer for the strapi blocks text element.",
     "license": "MIT",
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/freb97/nuxt-strapi-blocks-renderer.git"
+    },
     "type": "module",
     "exports": {
         ".": {
@@ -19,9 +23,11 @@
     "scripts": {
         "prepack": "nuxt-module-build build",
         "dev": "npm run dev:basic",
+        "dev:prepare": "nuxt-module-build build --stub && nuxt-module-build prepare",
         "dev:basic": "nuxi dev playground/basic",
         "dev:custom": "nuxi dev playground/custom",
         "release": "npm run lint && npm run test && npm run prepack && npm publish",
+        "release:ci": "npm run prepack && npm publish",
         "lint": "eslint './**/*.{js,ts,vue}' --max-warnings=0",
         "test": "vitest run",
         "test:watch": "vitest watch"