Nuxt Component Meta
![npm downloads](https://img.shields.io/npm/dt/nuxt-component-meta.svg?style=flat&colorA=002438&colorB=28CF8D)
Gather components metadata on build time and make them available on production. This module is developed to give a visual Markdown Editor with Vue Components in it for Nuxt Studio.
Quick Setup
- Add
nuxt-component-meta
dependency to your project:
pnpm add nuxt-component-meta
npm install nuxt-component-meta
- Add
nuxt-component-meta
to the modules
section of your nuxt.config.ts
export default defineNuxtConfig({
modules: ['nuxt-component-meta']
})
Usage
<template>
<div>
<h2>`MyComponent` metadata</h2>
<pre>
{{ meta }}
</pre>
</div>
</template>
<script script>
const { data: meta } = await useAsyncData('my-component', () => $fetch('/api/component-meta/my-component'))
</script>
Nightly Builds
You can install the latest nightly build of the Studio module by running:
npm i nuxt-component-meta@nightly
Development
- Clone this repository
- Install dependencies using
pnpm install
- Start dev server using
pnpm dev