@readme/markdown 15.2.1 → 15.4.0

package/dist/utils/common-html-words.d.ts

@@ -17,8 +17,15 @@ export declare const CUSTOM_PROP_BOUNDARIES: string[];
  */
 export declare const RUNTIME_COMPONENT_TAGS: Set<string>;
 /**
- * Standard HTML tags that should never be treated as custom components.
- * Uses the html-tags package, converted to a Set<string> for efficient lookups.
+ * Standard HTML tags list.
+ * A use case of this is to differentiate custom components tag vs standard HTML tags.
+ *
+ * Unioned from:
+ * - `html-tags`: All modern spec HTML elements
+ * - parse5's `TAG_NAMES`: Elements the HTML tree-construction algorithm has to special-case
+ *   This includes obsolete tags that are still rendered by browsers.
+ * - NON_STANDARD_TAGS: We've had to filter because currently parse5's `TAG_NAMES` set over-enumerates
+ *   tags that are not actually standard HTML tags. It also allows custom tags to be filtered out.
  */
 export declare const STANDARD_HTML_TAGS: Set<string>;
 /**

package/dist/utils/tailwind-compiler.d.ts

@@ -1,5 +1,17 @@
 import postcss from 'postcss';
-export declare function tailwindCompiler(classes: string[], { prefix, darkModeDataAttribute }: {
+export declare function tailwindCompiler(classes: string[], { prefix, darkModeDataAttribute, darkModeRootSelector, }: {
     darkModeDataAttribute?: string | null;
+    /**
+     * Scopes the `dark:` variant to `darkModeRootSelector[darkModeDataAttribute=dark]`
+     * (self or descendant) instead of matching `[darkModeDataAttribute=dark]` on *any*
+     * ancestor. Matches `when-color-mode-dark($root)` in `styles/mixins/when-color-mode-dark.scss`
+     * — see that mixin's doc comment for the full rationale (two independent
+     * `data-color-mode` scopes on one page, e.g. readme's SuperHub admin shell vs. the
+     * hub content it's previewing) and why there's no default: this package ships one
+     * precompiled stylesheet, so whatever a caller passes is permanent for every
+     * installer, and readme (this package's only real consumer today) is expected to
+     * pass its hub color-mode root, `.rm-ReadMe`.
+     */
+    darkModeRootSelector?: string | null;
     prefix: string;
 }): Promise<postcss.Result<postcss.Root>>;

package/package.json

@@ -2,7 +2,7 @@
   "name": "@readme/markdown",
   "description": "ReadMe's React-based Markdown parser",
   "author": "Rafe Goldberg <rafe@readme.io>",
-  "version": "15.2.1",
+  "version": "15.4.0",
   "main": "dist/main.node.js",
   "types": "dist/index.d.ts",
   "browser": "dist/main.js",
@@ -82,6 +82,7 @@
     "micromark-util-html-tag-name": "^2.0.1",
     "micromark-util-subtokenize": "2.0.4",
     "micromark-util-symbol": "^2.0.1",
+    "parse5": "^7.3.0",
     "path-browserify": "^1.0.1",
     "postcss": "^8.5.10",
     "postcss-prefix-selector": "^2.1.0",