@readme/markdown 13.8.4 → 14.0.0

package/dist/processor/transform/index.d.ts

@@ -38,7 +38,7 @@ declare const _default: ((({ isMdxish }?: {
     isMdxish?: boolean;
 }) => (tree: import("mdast").Root) => void) | (({ copyButtons }?: {
     copyButtons?: boolean;
-}) => (tree: import("mdast").Node) => import("mdast").Node) | (() => (tree: import("mdast").Node) => void) | (() => (tree: import("mdast").Root) => import("mdast").Root) | (({ isMdxish }?: {
+}) => (tree: import("mdast").Node) => import("mdast").Node) | (() => (tree: import("mdast").Node) => void) | (({ isMdxish }?: {
     isMdxish?: boolean;
-}) => (tree: import("mdast").Node) => import("mdast").Node))[];
+}) => (tree: import("mdast").Node) => import("mdast").Node) | (() => (tree: import("mdast").Root) => import("mdast").Root))[];
 export default _default;

package/dist/processor/transform/mdxish/mdxish-component-blocks.d.ts

@@ -6,6 +6,16 @@ import type { Plugin } from 'unified';
  * Handles both key-value attributes (theme="info") and boolean attributes (empty).
  */
 export declare const parseAttributes: (raw: string) => MdxJsxAttribute[];
+/**
+ * Parse an HTML tag string into structured data.
+ */
+export declare const parseTag: (value: string) => {
+    tag: string;
+    attributes: MdxJsxAttribute[];
+    selfClosing: boolean;
+    contentAfterTag: string;
+    attrString: string;
+};
 /**
  * Transform PascalCase HTML nodes into mdxJsxFlowElement nodes.
  *
@@ -13,9 +23,9 @@ export declare const parseAttributes: (raw: string) => MdxJsxAttribute[];
  * These are the custom readme MDX syntax for components.
  * This transformer identifies these patterns and converts them to proper MDX JSX elements so they
  * can be accurately recognized and rendered later with their component definition code.
- * Though for some tags, we need to handle them specially
  *
- * ## Supported HTML Structures
+ * The mdx-component micromark tokenizer ensures that multi-line components are captured
+ * as single HTML nodes, so this transformer only needs to handle two cases:
  *
  * ### 1. Self-closing tags
  * ```
@@ -25,45 +35,13 @@ export declare const parseAttributes: (raw: string) => MdxJsxAttribute[];
  *
  * ### 2. Self-contained blocks (entire component in single HTML node)
  * ```
- * <Button>Click me</Button>
- * ```
- * ```
  * <Component>
- *   <h2>Title</h2>
- *   <p>Content</p>
+ *   content
  * </Component>
  * ```
- * Parsed as: `html: "<Component>\n  <h2>Title</h2>\n  <p>Content</p>\n</Component>"`
- * The opening tag, content, and closing tag are all captured in one HTML node.
- *
- * ### 3. Multi-sibling components (closing tag in a following sibling)
- * Handles various structures where the closing tag is in a later sibling, such as:
- *
- * #### 3a. Block components (closing tag in sibling paragraph)
- * ```
- * <Callout>
- * Some **markdown** content
- * </Callout>
- * ```
- *
- * #### 3b. Multi-paragraph components (closing tag several siblings away)
- * ```
- * <Callout>
- *
- * First paragraph
- *
- * Second paragraph
- * </Callout>
- * ```
- *
- * #### 3c. Nested components split by blank lines (closing tag embedded in HTML sibling)
- * ```
- * <Outer>
- *   <Inner>content</Inner>
- *
- *   <Inner>content</Inner>
- * </Outer>
- * ```
+ * Parsed as: `html: "<Component>\n  content\n</Component>"`
+ * The opening tag, content, and closing tag are all captured in one HTML node
+ * (guaranteed by the mdx-component tokenizer).
  */
 declare const mdxishComponentBlocks: Plugin<[], Parent>;
 export default mdxishComponentBlocks;

package/package.json

@@ -2,7 +2,7 @@
   "name": "@readme/markdown",
   "description": "ReadMe's React-based Markdown parser",
   "author": "Rafe Goldberg <rafe@readme.io>",
-  "version": "13.8.4",
+  "version": "14.0.0",
   "main": "dist/main.node.js",
   "types": "dist/index.d.ts",
   "browser": "dist/main.js",

package/styles/gfm.scss

@@ -209,14 +209,14 @@
 
   ol ol,
   ul ol {
-    list-style-type: lower-roman;
+    list-style-type: lower-alpha;
   }
 
   ol ol ol,
   ol ul ol,
   ul ol ol,
   ul ul ol {
-    list-style-type: lower-alpha;
+    list-style-type: lower-roman;
   }
 
   dd {

package/dist/processor/transform/mdxish/constants.d.ts

@@ -1,5 +0,0 @@
-/**
- * Inline component tags handled by mdxish-inline-components.ts.
- * Also excluded from block-level handling in mdxish-component-blocks.ts.
- */
-export declare const INLINE_COMPONENT_TAGS: Set<string>;