@readme/markdown 6.75.0-beta.46 → 6.75.0-beta.48

package/components/Heading/index.tsx

@@ -0,0 +1,31 @@
+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;
+}
+
+const Heading = ({ tag: Tag = 'h3', depth = 3, id, children, ...attrs }: Props) => {
+  if (!children) return '';
+
+  return (
+    <Tag {...attrs} className={`heading heading-${depth} header-scroll`}>
+      <div key={`heading-anchor-${id}`} className="heading-anchor anchor waypoint" id={id} />
+      <div key={`heading-text-${id}`} className="heading-text">
+        {children}
+      </div>
+      <a
+        key={`heading-anchor-icon-${id}`}
+        aria-label={`Skip link to ${children}`}
+        className="heading-anchor-icon fa fa-anchor"
+        href={`#${id}`}
+      />
+    </Tag>
+  );
+};
+
+const CreateHeading = (depth: Depth) => (props: Props) => <Heading {...props} depth={depth} tag={`h${depth}`} />;
+
+export default CreateHeading;

package/components/TableOfContents/{index.jsx → index.tsx}

@@ -1,7 +1,6 @@
-import { element } from 'prop-types';
 import React from 'react';
 
-function TableOfContents({ children }) {
+function TableOfContents({ children }: React.PropsWithChildren) {
   return (
     <nav>
       <ul className="toc-list">
@@ -18,8 +17,4 @@ function TableOfContents({ children }) {
   );
 }
 
-TableOfContents.propTypes = {
-  children: element,
-};
-
 export default TableOfContents;

package/components/index.ts

@@ -7,6 +7,5 @@ export { default as Glossary } from './Glossary';
 export { default as HTMLBlock } from './HTMLBlock';
 export { default as Heading } from './Heading';
 export { default as Image } from './Image';
-export { default as Style } from './Style';
 export { default as Table } from './Table';
 export { default as TableOfContents } from './TableOfContents';

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

@@ -0,0 +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;
+}
+declare const CreateHeading: (depth: Depth) => (props: Props) => React.JSX.Element;
+export default CreateHeading;

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

@@ -0,0 +1,3 @@
+import React from 'react';
+declare function TableOfContents({ children }: React.PropsWithChildren): React.JSX.Element;
+export default TableOfContents;

package/dist/components/index.d.ts

@@ -7,6 +7,5 @@ export { default as Glossary } from './Glossary';
 export { default as HTMLBlock } from './HTMLBlock';
 export { default as Heading } from './Heading';
 export { default as Image } from './Image';
-export { default as Style } from './Style';
 export { default as Table } from './Table';
 export { default as TableOfContents } from './TableOfContents';

package/dist/contexts/index.d.ts

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

package/dist/enums.d.ts

@@ -1,12 +1,13 @@
 export declare enum NodeTypes {
     callout = "rdme-callout",
     codeTabs = "code-tabs",
+    embed = "embed",
     emoji = "gemoji",
+    glossary = "readme-glossary-item",
+    htmlBlock = "html-block",
     i = "i",
     image = "image",
-    htmlBlock = "html-block",
-    embed = "embed",
-    variable = "readme-variable",
-    glossary = "readme-glossary-item",
-    reusableContent = "reusable-content"
+    reusableContent = "reusable-content",
+    tutorialTile = "tutorial-tile",
+    variable = "readme-variable"
 }

package/dist/index.d.ts

@@ -1,34 +1,13 @@
-import React from 'react';
-import { RunOptions } from '@mdx-js/mdx';
 import * as Components from './components';
-import { GlossaryTerm } from './contexts/GlossaryTerms';
+import { compile, run, mdx } from './lib';
 import './styles/main.scss';
-type ComponentOpts = Record<string, (props: any) => React.ReactNode>;
-interface Variables {
-    user: Record<string, string>;
-    defaults: {
-        name: string;
-        default: string;
-    }[];
-}
-export type RunOpts = Omit<RunOptions, 'Fragment'> & {
-    components?: ComponentOpts;
-    imports?: Record<string, unknown>;
-    baseUrl?: string;
-    terms?: GlossaryTerm[];
-    variables?: Variables;
-};
-export { Components };
-export declare const utils: {
+declare const utils: {
     readonly options: any;
     getHref: any;
     calloutIcons: {};
 };
+export { compile, run, mdx, Components, utils };
 export declare const reactProcessor: (opts?: {}) => import("unified").Processor<import("mdast").Root, import("estree").Program, import("estree").Program, import("estree").Program, string>;
-export declare const compile: (text: string, opts?: {}) => string;
-export declare const run: (code: string, _opts?: RunOpts) => Promise<() => React.JSX.Element>;
-export declare const reactTOC: (text: string, opts?: {}) => void;
-export declare const mdx: (tree: any, opts?: {}) => string;
 export declare const html: (text: string, opts?: {}) => void;
 export declare const mdast: any;
 export declare const hast: (text: string, opts?: {}) => import("hast").Root;

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

@@ -0,0 +1,8 @@
+import remarkFrontmatter from 'remark-frontmatter';
+import remarkGfm from 'remark-gfm';
+export type MdastOpts = {
+    components?: Record<string, string>;
+};
+export declare const remarkPlugins: ((() => (tree: any) => void) | typeof remarkFrontmatter | typeof remarkGfm)[];
+declare const astProcessor: (opts?: MdastOpts) => import("unified").Processor<import("mdast").Root, import("mdast").Root, import("mdast").Root, import("mdast").Root, string>;
+export default astProcessor;

package/dist/lib/compile.d.ts

@@ -0,0 +1,9 @@
+import { CompileOptions } from '@mdx-js/mdx';
+import { VFileWithToc } from '../types';
+export type CompileOpts = CompileOptions & {
+    components?: Record<string, VFileWithToc>;
+    lazyImages?: boolean;
+    safeMode?: boolean;
+};
+declare const compile: (text: string, opts?: CompileOpts) => VFileWithToc;
+export default compile;

package/dist/lib/index.d.ts

@@ -0,0 +1,6 @@
+import astProcessor, { MdastOpts, remarkPlugins } from './ast-processor';
+import compile from './compile';
+import mdx from './mdx';
+import run from './run';
+export type { MdastOpts };
+export { astProcessor, compile, mdx, run, remarkPlugins };

package/dist/lib/mdx.d.ts

@@ -0,0 +1,4 @@
+export declare const mdx: (tree: any, { hast }?: {
+    hast?: boolean;
+}) => string;
+export default mdx;

package/dist/lib/run.d.ts

@@ -0,0 +1,24 @@
+import React from 'react';
+import { RunOptions } from '@mdx-js/mdx';
+import { VFileWithToc } from '../types';
+import { GlossaryTerm } from '../contexts/GlossaryTerms';
+interface Variables {
+    user: Record<string, string>;
+    defaults: {
+        name: string;
+        default: string;
+    }[];
+}
+export type RunOpts = Omit<RunOptions, 'Fragment'> & {
+    components?: ComponentOpts;
+    imports?: Record<string, unknown>;
+    baseUrl?: string;
+    terms?: GlossaryTerm[];
+    variables?: Variables;
+};
+type ComponentOpts = Record<string, (props: any) => React.ReactNode>;
+declare const run: (stringOrFile: string | VFileWithToc, _opts?: RunOpts) => Promise<{
+    default: () => React.JSX.Element;
+    toc: () => React.JSX.Element;
+}>;
+export default run;