@readme/markdown 8.1.0 → 8.3.0

package/dist/components/HTMLBlock/index.d.ts

@@ -1,7 +1,8 @@
 import React from 'react';
-declare const HTMLBlock: ({ children, runScripts, safeMode }: {
-    children?: string;
-    runScripts: any;
+interface Props {
+    children: React.ReactElement | string;
+    runScripts?: boolean | string;
     safeMode?: boolean;
-}) => React.JSX.Element;
+}
+declare const HTMLBlock: ({ children, runScripts, safeMode }: Props) => React.JSX.Element;
 export default HTMLBlock;

package/dist/components/Heading/index.d.ts

@@ -1,8 +1,8 @@
 import React from 'react';
 export type Depth = 1 | 2 | 3 | 4 | 5 | 6;
 interface Props extends React.PropsWithChildren<React.HTMLAttributes<HTMLHeadingElement>> {
-    tag: 'h1' | 'h2' | 'h3' | 'h4' | 'h5' | 'h6';
     depth: Depth;
+    tag: 'h1' | 'h2' | 'h3' | 'h4' | 'h5' | 'h6';
 }
 declare const CreateHeading: (depth: Depth) => (props: Props) => React.JSX.Element;
 export default CreateHeading;

package/dist/components/Image/index.d.ts

@@ -4,13 +4,13 @@ interface ImageProps {
     alt?: string;
     border?: boolean;
     caption?: string;
+    children?: [React.ReactElement];
     className?: string;
     height?: string;
+    lazy?: boolean;
     src: string;
     title?: string;
     width?: string;
-    lazy?: boolean;
-    children?: [React.ReactElement];
 }
 declare const Image: (Props: ImageProps) => React.JSX.Element;
 export default Image;

package/dist/components/Table/index.d.ts

@@ -1,7 +1,7 @@
 import React from 'react';
 interface Props extends JSX.IntrinsicAttributes {
-    align: ('left' | 'center' | 'right')[];
-    children: [React.ReactElement<HTMLTableCaptionElement | HTMLTableSectionElement | HTMLTableRowElement>];
+    align: ('center' | 'left' | 'right')[];
+    children: [React.ReactElement<HTMLTableCaptionElement | HTMLTableRowElement | HTMLTableSectionElement>];
 }
 declare const Table: (props: Props) => React.JSX.Element;
 export default Table;

package/dist/components/Tabs/index.d.ts

@@ -1,9 +1,8 @@
 import React from 'react';
 import './style.scss';
-export declare const Tab: ({ children }: {
-    children: any;
-}) => React.JSX.Element;
-declare const Tabs: ({ children }: {
-    children: any;
-}) => React.JSX.Element;
+export declare const Tab: ({ children }: React.PropsWithChildren) => React.JSX.Element;
+interface TabsProps {
+    children?: React.ReactElement[];
+}
+declare const Tabs: ({ children }: TabsProps) => React.JSX.Element;
 export default Tabs;

package/dist/components/TailwindRoot/index.d.ts

@@ -1,6 +1,7 @@
 import React from 'react';
-declare const TailwindRoot: ({ children, flow }: {
-    children: any;
-    flow: any;
-}) => React.JSX.Element;
+interface Props extends React.PropsWithChildren<{
+    flow: boolean;
+}> {
+}
+declare const TailwindRoot: ({ children, flow }: Props) => React.JSX.Element;
 export default TailwindRoot;

package/dist/contexts/GlossaryTerms.d.ts

@@ -1,7 +1,7 @@
-export type GlossaryTerm = {
-    term: string;
-    definition: string;
+export interface GlossaryTerm {
     _id?: string;
-};
+    definition: string;
+    term: string;
+}
 declare const GlossaryContext: import("react").Context<GlossaryTerm[]>;
 export default GlossaryContext;

package/dist/contexts/index.d.ts

@@ -1,5 +1,5 @@
+import type { RunOpts } from '../lib/run';
 import React from 'react';
-import { RunOpts } from '../lib/run';
-type Props = React.PropsWithChildren & Pick<RunOpts, 'baseUrl' | 'terms' | 'variables'>;
+type Props = Pick<RunOpts, 'baseUrl' | 'terms' | 'variables'> & React.PropsWithChildren;
 declare const Contexts: ({ children, terms, variables, baseUrl }: Props) => React.ReactNode;
 export default Contexts;

package/dist/errors/mdx-syntax-error.d.ts

@@ -1,4 +1,4 @@
-import { VFileMessage } from 'vfile-message';
+import type { VFileMessage } from 'vfile-message';
 export default class MdxSyntaxError extends SyntaxError {
     original: VFileMessage;
     constructor(error: VFileMessage, doc: string);

package/dist/example/RenderError.d.ts

@@ -1,4 +1,5 @@
-import React, { PropsWithChildren } from 'react';
+import type { PropsWithChildren } from 'react';
+import React from 'react';
 interface Props {
     error?: string;
 }
@@ -15,9 +16,9 @@ declare class RenderError extends React.Component<PropsWithChildren<Props>, Stat
         hasError: boolean;
         message: string;
     };
-    componentDidCatch(error: any, info: {
-        componentStack: any;
+    static componentDidCatch(error: Error, info: {
+        componentStack: string;
     }): void;
-    render(): string | number | boolean | React.JSX.Element | Iterable<React.ReactNode>;
+    render(): string | number | boolean | Iterable<React.ReactNode> | React.JSX.Element;
 }
 export default RenderError;

package/dist/lib/ast-processor.d.ts

@@ -1,12 +1,12 @@
+import type { PluggableList } from 'unified';
+import rehypeSlug from 'rehype-slug';
 import remarkFrontmatter from 'remark-frontmatter';
 import remarkGfm from 'remark-gfm';
-import rehypeSlug from 'rehype-slug';
-import { PluggableList } from 'unified';
-export type MdastOpts = {
+export interface MdastOpts {
     components?: Record<string, string>;
     remarkPlugins?: PluggableList;
-};
-export declare const remarkPlugins: ((() => (tree: any) => void) | (({ copyButtons }?: {
+}
+export declare const remarkPlugins: ((() => (tree: import("mdast").Root) => void) | (({ copyButtons }?: {
     copyButtons?: boolean;
 }) => (tree: import("mdast").Node) => import("mdast").Node) | typeof remarkFrontmatter | typeof remarkGfm)[];
 export declare const rehypePlugins: ((() => (tree: import("unist").Node) => import("unist").Node) | typeof rehypeSlug)[];

package/dist/lib/compile.d.ts

@@ -1,7 +1,5 @@
-import { CompileOptions } from '@mdx-js/mdx';
+import type { CompileOptions } from '@mdx-js/mdx';
 export type CompileOpts = CompileOptions & {
-    lazyImages?: boolean;
-    safeMode?: boolean;
     components?: Record<string, string>;
     copyButtons?: boolean;
     useTailwind?: boolean;

package/dist/lib/hast.d.ts

@@ -1,3 +1,3 @@
-import { MdastOpts } from './ast-processor';
+import type { MdastOpts } from './ast-processor';
 declare const hast: (text: string, opts?: MdastOpts) => import("hast").Root;
 export default hast;

package/dist/lib/mdast.d.ts

@@ -1,2 +1,4 @@
-declare const mdast: any;
+import type { MdastOpts } from './ast-processor';
+import type { Root } from 'mdast';
+declare const mdast: (text: string, opts?: MdastOpts) => Root;
 export default mdast;

package/dist/lib/mdastV6.d.ts

@@ -1,2 +1,5 @@
-declare const mdastV6: any;
+import type { Root } from 'mdast';
+declare const mdastV6: (doc: string, { rdmd }: {
+    rdmd: any;
+}) => Root;
 export default mdastV6;

package/dist/lib/mdx.d.ts

@@ -1,4 +1,6 @@
-export declare const mdx: (tree: any, { hast, ...opts }?: {
+import type { Root as HastRoot } from 'hast';
+import type { Root as MdastRoot } from 'mdast';
+export declare const mdx: (tree: HastRoot | MdastRoot, { hast, ...opts }?: {
     hast?: boolean;
 }) => string;
 export default mdx;

package/dist/lib/plain.d.ts

@@ -1,4 +1,4 @@
-import { Nodes } from 'hast';
+import type { Nodes } from 'hast';
 interface Options {
     variables?: Record<string, string>;
 }

package/dist/lib/run.d.ts

@@ -1,19 +1,13 @@
-import React from 'react';
-import { RunOptions } from '@mdx-js/mdx';
-import { GlossaryTerm } from '../contexts/GlossaryTerms';
-import { CustomComponents } from '../types';
-import { Variables } from '../utils/user';
+import type { GlossaryTerm } from '../contexts/GlossaryTerms';
+import type { CustomComponents, RMDXModule } from '../types';
+import type { Variables } from '../utils/user';
+import type { RunOptions } from '@mdx-js/mdx';
 export type RunOpts = Omit<RunOptions, 'Fragment'> & {
+    baseUrl?: string;
     components?: CustomComponents;
     imports?: Record<string, unknown>;
-    baseUrl?: string;
     terms?: GlossaryTerm[];
     variables?: Variables;
 };
-declare const run: (string: string, _opts?: RunOpts) => Promise<{
-    default: () => React.JSX.Element;
-    toc: import("../types").IndexableElements[];
-    Toc: () => React.JSX.Element;
-    stylesheet: string;
-}>;
+declare const run: (string: string, _opts?: RunOpts) => Promise<RMDXModule>;
 export default run;