@nuxtjs/mdc 0.18.2 → 0.18.4

package/README.md

@@ -488,9 +488,11 @@ You can dive into this module online using StackBlitz:
 
 Or locally:
 
-1. Clone this repository
-2. Install dependencies using `pnpm install`
-3. Start the development server using `pnpm dev`
+- Clone this repository
+- Install dependencies using `pnpm install`
+- Prepare using pnpm `dev:prepare`
+- Start the development server using `pnpm dev`
+- Test using `pnpm test`
 
 ## License
 

package/dist/module.d.mts

@@ -104,10 +104,16 @@ interface MDCStringifyOptions {
         options?: YamlToStringOptions;
     };
     plugins?: {
-        remarkStringify?: {
+        'remarkStringify'?: {
             options?: Options$1;
         };
-        remarkMDC?: {
+        /**
+         * @deprecated use 'remark-mdc' instead
+         */
+        'remarkMDC'?: {
+            options?: RemarkMDCOptions;
+        };
+        'remark-mdc'?: {
             options?: RemarkMDCOptions;
         };
     };

package/dist/module.json

@@ -1,7 +1,7 @@
 {
   "name": "@nuxtjs/mdc",
   "configKey": "mdc",
-  "version": "0.18.2",
+  "version": "0.18.4",
   "builder": {
     "@nuxt/module-builder": "1.0.2",
     "unbuild": "3.6.1"

package/dist/module.mjs

@@ -227,7 +227,7 @@ const DefaultHighlightLangs = [
   "mdc",
   "yaml"
 ];
-const module = defineNuxtModule({
+const module$1 = defineNuxtModule({
   meta: {
     name: "@nuxtjs/mdc",
     configKey: "mdc"
@@ -430,4 +430,4 @@ function resolveOptions(options) {
   }
 }
 
-export { DefaultHighlightLangs, module as default };
+export { DefaultHighlightLangs, module$1 as default };

package/dist/runtime/components/MDC.d.vue.ts

@@ -0,0 +1,141 @@
+import type { PropType } from 'vue';
+import type { MDCParseOptions } from '@nuxtjs/mdc';
+declare var __VLS_1: {
+    data: any;
+    body: any;
+    toc: any;
+    excerpt: any;
+    error: import("nuxt/app").NuxtError<unknown> | undefined;
+};
+type __VLS_Slots = {} & {
+    default?: (props: typeof __VLS_1) => any;
+};
+declare const __VLS_base: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
+    tag: {
+        type: (BooleanConstructor | StringConstructor)[];
+        default: string;
+    };
+    /**
+     * Raw markdown string or parsed markdown object from `parseMarkdown`
+     */
+    value: {
+        type: (ObjectConstructor | StringConstructor)[];
+        required: true;
+    };
+    /**
+     * Render only the excerpt
+     */
+    excerpt: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Options for `parseMarkdown`
+     */
+    parserOptions: {
+        type: PropType<MDCParseOptions>;
+        default: () => {};
+    };
+    /**
+     * Class to be applied to the root element
+     */
+    class: {
+        type: (ObjectConstructor | ArrayConstructor | StringConstructor)[];
+        default: string;
+    };
+    /**
+     * Tags to unwrap separated by spaces
+     * Example: 'ul li'
+     */
+    unwrap: {
+        type: (BooleanConstructor | StringConstructor)[];
+        default: boolean;
+    };
+    /**
+     * Async Data Unique Key
+     * @default `hash(props.value)`
+     */
+    cacheKey: {
+        type: StringConstructor;
+        default: undefined;
+    };
+    /**
+     * Partial parsing (if partial is `true`, title and toc generation will not be generated)
+     */
+    partial: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+}>, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+    tag: {
+        type: (BooleanConstructor | StringConstructor)[];
+        default: string;
+    };
+    /**
+     * Raw markdown string or parsed markdown object from `parseMarkdown`
+     */
+    value: {
+        type: (ObjectConstructor | StringConstructor)[];
+        required: true;
+    };
+    /**
+     * Render only the excerpt
+     */
+    excerpt: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Options for `parseMarkdown`
+     */
+    parserOptions: {
+        type: PropType<MDCParseOptions>;
+        default: () => {};
+    };
+    /**
+     * Class to be applied to the root element
+     */
+    class: {
+        type: (ObjectConstructor | ArrayConstructor | StringConstructor)[];
+        default: string;
+    };
+    /**
+     * Tags to unwrap separated by spaces
+     * Example: 'ul li'
+     */
+    unwrap: {
+        type: (BooleanConstructor | StringConstructor)[];
+        default: boolean;
+    };
+    /**
+     * Async Data Unique Key
+     * @default `hash(props.value)`
+     */
+    cacheKey: {
+        type: StringConstructor;
+        default: undefined;
+    };
+    /**
+     * Partial parsing (if partial is `true`, title and toc generation will not be generated)
+     */
+    partial: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+}>> & Readonly<{}>, {
+    tag: string | boolean;
+    excerpt: boolean;
+    parserOptions: MDCParseOptions;
+    class: string | Record<string, any> | unknown[];
+    unwrap: string | boolean;
+    cacheKey: string;
+    partial: boolean;
+}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;
+declare const __VLS_export: __VLS_WithSlots<typeof __VLS_base, __VLS_Slots>;
+declare const _default: typeof __VLS_export;
+export default _default;
+type __VLS_WithSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};

package/dist/runtime/components/MDC.vue.d.ts

@@ -12,14 +12,14 @@ type __VLS_Slots = {} & {
 };
 declare const __VLS_base: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
     tag: {
-        type: (StringConstructor | BooleanConstructor)[];
+        type: (BooleanConstructor | StringConstructor)[];
         default: string;
     };
     /**
      * Raw markdown string or parsed markdown object from `parseMarkdown`
      */
     value: {
-        type: (StringConstructor | ObjectConstructor)[];
+        type: (ObjectConstructor | StringConstructor)[];
         required: true;
     };
     /**
@@ -40,7 +40,7 @@ declare const __VLS_base: import("vue").DefineComponent<import("vue").ExtractPro
      * Class to be applied to the root element
      */
     class: {
-        type: (StringConstructor | ObjectConstructor | ArrayConstructor)[];
+        type: (ObjectConstructor | ArrayConstructor | StringConstructor)[];
         default: string;
     };
     /**
@@ -48,7 +48,7 @@ declare const __VLS_base: import("vue").DefineComponent<import("vue").ExtractPro
      * Example: 'ul li'
      */
     unwrap: {
-        type: (StringConstructor | BooleanConstructor)[];
+        type: (BooleanConstructor | StringConstructor)[];
         default: boolean;
     };
     /**
@@ -68,14 +68,14 @@ declare const __VLS_base: import("vue").DefineComponent<import("vue").ExtractPro
     };
 }>, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
     tag: {
-        type: (StringConstructor | BooleanConstructor)[];
+        type: (BooleanConstructor | StringConstructor)[];
         default: string;
     };
     /**
      * Raw markdown string or parsed markdown object from `parseMarkdown`
      */
     value: {
-        type: (StringConstructor | ObjectConstructor)[];
+        type: (ObjectConstructor | StringConstructor)[];
         required: true;
     };
     /**
@@ -96,7 +96,7 @@ declare const __VLS_base: import("vue").DefineComponent<import("vue").ExtractPro
      * Class to be applied to the root element
      */
     class: {
-        type: (StringConstructor | ObjectConstructor | ArrayConstructor)[];
+        type: (ObjectConstructor | ArrayConstructor | StringConstructor)[];
         default: string;
     };
     /**
@@ -104,7 +104,7 @@ declare const __VLS_base: import("vue").DefineComponent<import("vue").ExtractPro
      * Example: 'ul li'
      */
     unwrap: {
-        type: (StringConstructor | BooleanConstructor)[];
+        type: (BooleanConstructor | StringConstructor)[];
         default: boolean;
     };
     /**
@@ -126,7 +126,7 @@ declare const __VLS_base: import("vue").DefineComponent<import("vue").ExtractPro
     tag: string | boolean;
     excerpt: boolean;
     parserOptions: MDCParseOptions;
-    class: string | unknown[] | Record<string, any>;
+    class: string | Record<string, any> | unknown[];
     unwrap: string | boolean;
     cacheKey: string;
     partial: boolean;

package/dist/runtime/components/MDCCached.d.vue.ts

@@ -0,0 +1,156 @@
+import type { PropType, DefineComponent } from 'vue';
+import type { MDCParseOptions } from '@nuxtjs/mdc';
+declare var __VLS_1: {
+    data: any;
+    body: any;
+    toc: any;
+    excerpt: any;
+    error: import("nuxt/app").NuxtError<unknown> | undefined;
+};
+type __VLS_Slots = {} & {
+    default?: (props: typeof __VLS_1) => any;
+};
+declare const __VLS_base: DefineComponent<import("vue").ExtractPropTypes<{
+    tag: {
+        type: (BooleanConstructor | StringConstructor)[];
+        default: string;
+    };
+    /**
+     * Raw markdown string or parsed markdown object from `parseMarkdown`
+     */
+    value: {
+        type: (ObjectConstructor | StringConstructor)[];
+        required: true;
+    };
+    /**
+     * Render only the excerpt
+     */
+    excerpt: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Options for `parseMarkdown`
+     */
+    parserOptions: {
+        type: PropType<MDCParseOptions>;
+        default: () => {};
+    };
+    /**
+     * Class to be applied to the root element
+     */
+    class: {
+        type: (ObjectConstructor | ArrayConstructor | StringConstructor)[];
+        default: string;
+    };
+    /**
+     * Tags to unwrap separated by spaces
+     * Example: 'ul li'
+     */
+    unwrap: {
+        type: (BooleanConstructor | StringConstructor)[];
+        default: boolean;
+    };
+    /**
+     * Async Data Unique Key
+     * @default `hash(props.value)`
+     */
+    cacheKey: {
+        type: StringConstructor;
+        default: undefined;
+    };
+    /**
+     * Partial parsing (if partial is `true`, title and toc generation will not be generated)
+     */
+    partial: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * The map of custom components to use for rendering.
+     */
+    components: {
+        type: PropType<Record<string, string | DefineComponent<any, any, any>>>;
+        default: () => {};
+    };
+}>, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+    tag: {
+        type: (BooleanConstructor | StringConstructor)[];
+        default: string;
+    };
+    /**
+     * Raw markdown string or parsed markdown object from `parseMarkdown`
+     */
+    value: {
+        type: (ObjectConstructor | StringConstructor)[];
+        required: true;
+    };
+    /**
+     * Render only the excerpt
+     */
+    excerpt: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Options for `parseMarkdown`
+     */
+    parserOptions: {
+        type: PropType<MDCParseOptions>;
+        default: () => {};
+    };
+    /**
+     * Class to be applied to the root element
+     */
+    class: {
+        type: (ObjectConstructor | ArrayConstructor | StringConstructor)[];
+        default: string;
+    };
+    /**
+     * Tags to unwrap separated by spaces
+     * Example: 'ul li'
+     */
+    unwrap: {
+        type: (BooleanConstructor | StringConstructor)[];
+        default: boolean;
+    };
+    /**
+     * Async Data Unique Key
+     * @default `hash(props.value)`
+     */
+    cacheKey: {
+        type: StringConstructor;
+        default: undefined;
+    };
+    /**
+     * Partial parsing (if partial is `true`, title and toc generation will not be generated)
+     */
+    partial: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * The map of custom components to use for rendering.
+     */
+    components: {
+        type: PropType<Record<string, string | DefineComponent<any, any, any>>>;
+        default: () => {};
+    };
+}>> & Readonly<{}>, {
+    tag: string | boolean;
+    excerpt: boolean;
+    parserOptions: MDCParseOptions;
+    class: string | Record<string, any> | unknown[];
+    unwrap: string | boolean;
+    cacheKey: string;
+    partial: boolean;
+    components: Record<string, string | DefineComponent<any, any, any>>;
+}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;
+declare const __VLS_export: __VLS_WithSlots<typeof __VLS_base, __VLS_Slots>;
+declare const _default: typeof __VLS_export;
+export default _default;
+type __VLS_WithSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};

package/dist/runtime/components/MDCCached.vue.d.ts

@@ -12,14 +12,14 @@ type __VLS_Slots = {} & {
 };
 declare const __VLS_base: DefineComponent<import("vue").ExtractPropTypes<{
     tag: {
-        type: (StringConstructor | BooleanConstructor)[];
+        type: (BooleanConstructor | StringConstructor)[];
         default: string;
     };
     /**
      * Raw markdown string or parsed markdown object from `parseMarkdown`
      */
     value: {
-        type: (StringConstructor | ObjectConstructor)[];
+        type: (ObjectConstructor | StringConstructor)[];
         required: true;
     };
     /**
@@ -40,7 +40,7 @@ declare const __VLS_base: DefineComponent<import("vue").ExtractPropTypes<{
      * Class to be applied to the root element
      */
     class: {
-        type: (StringConstructor | ObjectConstructor | ArrayConstructor)[];
+        type: (ObjectConstructor | ArrayConstructor | StringConstructor)[];
         default: string;
     };
     /**
@@ -48,7 +48,7 @@ declare const __VLS_base: DefineComponent<import("vue").ExtractPropTypes<{
      * Example: 'ul li'
      */
     unwrap: {
-        type: (StringConstructor | BooleanConstructor)[];
+        type: (BooleanConstructor | StringConstructor)[];
         default: boolean;
     };
     /**
@@ -75,14 +75,14 @@ declare const __VLS_base: DefineComponent<import("vue").ExtractPropTypes<{
     };
 }>, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
     tag: {
-        type: (StringConstructor | BooleanConstructor)[];
+        type: (BooleanConstructor | StringConstructor)[];
         default: string;
     };
     /**
      * Raw markdown string or parsed markdown object from `parseMarkdown`
      */
     value: {
-        type: (StringConstructor | ObjectConstructor)[];
+        type: (ObjectConstructor | StringConstructor)[];
         required: true;
     };
     /**
@@ -103,7 +103,7 @@ declare const __VLS_base: DefineComponent<import("vue").ExtractPropTypes<{
      * Class to be applied to the root element
      */
     class: {
-        type: (StringConstructor | ObjectConstructor | ArrayConstructor)[];
+        type: (ObjectConstructor | ArrayConstructor | StringConstructor)[];
         default: string;
     };
     /**
@@ -111,7 +111,7 @@ declare const __VLS_base: DefineComponent<import("vue").ExtractPropTypes<{
      * Example: 'ul li'
      */
     unwrap: {
-        type: (StringConstructor | BooleanConstructor)[];
+        type: (BooleanConstructor | StringConstructor)[];
         default: boolean;
     };
     /**
@@ -140,7 +140,7 @@ declare const __VLS_base: DefineComponent<import("vue").ExtractPropTypes<{
     tag: string | boolean;
     excerpt: boolean;
     parserOptions: MDCParseOptions;
-    class: string | unknown[] | Record<string, any>;
+    class: string | Record<string, any> | unknown[];
     unwrap: string | boolean;
     cacheKey: string;
     partial: boolean;

package/dist/runtime/components/MDCRenderer.d.vue.ts

@@ -0,0 +1,124 @@
+import type { PropType, DefineComponent } from 'vue';
+import type { MDCRoot } from '@nuxtjs/mdc';
+declare const __VLS_export: DefineComponent<import("vue").ExtractPropTypes<{
+    /**
+     * Content to render
+     */
+    body: {
+        type: PropType<MDCRoot>;
+        required: true;
+    };
+    /**
+     * Document meta data
+     */
+    data: {
+        type: ObjectConstructor;
+        default: () => {};
+    };
+    /**
+     * Class(es) to bind to the component
+     */
+    class: {
+        type: (ObjectConstructor | StringConstructor)[];
+        default: undefined;
+    };
+    /**
+     * Root tag to use for rendering
+     */
+    tag: {
+        type: (BooleanConstructor | StringConstructor)[];
+        default: undefined;
+    };
+    /**
+     * Whether or not to render Prose components instead of HTML tags
+     */
+    prose: {
+        type: BooleanConstructor;
+        default: undefined;
+    };
+    /**
+     * The map of custom components to use for rendering.
+     */
+    components: {
+        type: PropType<Record<string, string | DefineComponent<any, any, any>>>;
+        default: () => {};
+    };
+    /**
+     * Tags to unwrap separated by spaces
+     * Example: 'ul li'
+     */
+    unwrap: {
+        type: (BooleanConstructor | StringConstructor)[];
+        default: boolean;
+    };
+}>, {
+    tags: import("vue").ComputedRef<any>;
+    contentKey: import("vue").ComputedRef<string>;
+    route: any;
+    runtimeData: {
+        [x: string]: any;
+    };
+    updateRuntimeData: (code: string, value: any) => {
+        [x: string]: any;
+    };
+}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+    /**
+     * Content to render
+     */
+    body: {
+        type: PropType<MDCRoot>;
+        required: true;
+    };
+    /**
+     * Document meta data
+     */
+    data: {
+        type: ObjectConstructor;
+        default: () => {};
+    };
+    /**
+     * Class(es) to bind to the component
+     */
+    class: {
+        type: (ObjectConstructor | StringConstructor)[];
+        default: undefined;
+    };
+    /**
+     * Root tag to use for rendering
+     */
+    tag: {
+        type: (BooleanConstructor | StringConstructor)[];
+        default: undefined;
+    };
+    /**
+     * Whether or not to render Prose components instead of HTML tags
+     */
+    prose: {
+        type: BooleanConstructor;
+        default: undefined;
+    };
+    /**
+     * The map of custom components to use for rendering.
+     */
+    components: {
+        type: PropType<Record<string, string | DefineComponent<any, any, any>>>;
+        default: () => {};
+    };
+    /**
+     * Tags to unwrap separated by spaces
+     * Example: 'ul li'
+     */
+    unwrap: {
+        type: (BooleanConstructor | StringConstructor)[];
+        default: boolean;
+    };
+}>> & Readonly<{}>, {
+    data: Record<string, any>;
+    tag: string | boolean;
+    class: string | Record<string, any>;
+    unwrap: string | boolean;
+    components: Record<string, string | DefineComponent<any, any, any>>;
+    prose: boolean;
+}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;
+declare const _default: typeof __VLS_export;
+export default _default;

package/dist/runtime/components/MDCRenderer.vue.d.ts

@@ -19,14 +19,14 @@ declare const __VLS_export: DefineComponent<import("vue").ExtractPropTypes<{
      * Class(es) to bind to the component
      */
     class: {
-        type: (StringConstructor | ObjectConstructor)[];
+        type: (ObjectConstructor | StringConstructor)[];
         default: undefined;
     };
     /**
      * Root tag to use for rendering
      */
     tag: {
-        type: (StringConstructor | BooleanConstructor)[];
+        type: (BooleanConstructor | StringConstructor)[];
         default: undefined;
     };
     /**
@@ -48,7 +48,7 @@ declare const __VLS_export: DefineComponent<import("vue").ExtractPropTypes<{
      * Example: 'ul li'
      */
     unwrap: {
-        type: (StringConstructor | BooleanConstructor)[];
+        type: (BooleanConstructor | StringConstructor)[];
         default: boolean;
     };
 }>, {
@@ -80,14 +80,14 @@ declare const __VLS_export: DefineComponent<import("vue").ExtractPropTypes<{
      * Class(es) to bind to the component
      */
     class: {
-        type: (StringConstructor | ObjectConstructor)[];
+        type: (ObjectConstructor | StringConstructor)[];
         default: undefined;
     };
     /**
      * Root tag to use for rendering
      */
     tag: {
-        type: (StringConstructor | BooleanConstructor)[];
+        type: (BooleanConstructor | StringConstructor)[];
         default: undefined;
     };
     /**
@@ -109,14 +109,14 @@ declare const __VLS_export: DefineComponent<import("vue").ExtractPropTypes<{
      * Example: 'ul li'
      */
     unwrap: {
-        type: (StringConstructor | BooleanConstructor)[];
+        type: (BooleanConstructor | StringConstructor)[];
         default: boolean;
     };
 }>> & Readonly<{}>, {
+    data: Record<string, any>;
     tag: string | boolean;
     class: string | Record<string, any>;
     unwrap: string | boolean;
-    data: Record<string, any>;
     components: Record<string, string | DefineComponent<any, any, any>>;
     prose: boolean;
 }, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;