writr 6.0.0 → 6.1.0

package/README.md

@@ -22,6 +22,7 @@
 * Github Flavor Markdown (remark-gfm).
 * Emoji Support (remark-emoji).
 * MDX Support (remark-mdx).
+* Raw HTML Passthrough (rehype-raw).
 * Built in Hooks for adding code to render pipeline.
 * AI-powered metadata generation, SEO, and translation via the [Vercel AI SDK](https://sdk.vercel.ai).
 
@@ -118,6 +119,7 @@ const writrOptions = {
     gfm: true,
     math: true,
     mdx: true,
+    rawHtml: false,
     caching: true,
   }
 };
@@ -142,6 +144,7 @@ const writrOptions = {
     gfm: true,
     math: true,
     mdx: true,
+    rawHtml: false,
     caching: true,
   }
 };
@@ -190,11 +193,16 @@ Accessing the default options for this instance of Writr. Here is the default se
     gfm: true,
     math: true,
     mdx: false,
+    rawHtml: false,
     caching: true,
   }
 }
 ```
 
+By default, raw HTML in markdown (such as `<iframe>`, `<video>`, or `<div>` tags) is stripped during rendering. Set `rawHtml: true` to preserve raw HTML elements and their attributes in the rendered output. This is useful for embedding videos, widgets, or custom HTML in your markdown content.
+
+**Note:** Setting `mdx: true` also enables raw HTML passthrough as part of the MDX specification. The `rawHtml` option is for enabling raw HTML in standard markdown without using MDX.
+
 ## `.frontmatter`
 
 Accessing the frontmatter for this instance of Writr. This is a `Record<string, any>` and can be set via the `.content` property.
@@ -921,14 +929,13 @@ Generate SEO metadata using `writr.ai.getSEO()`. By default all fields are gener
 ```typescript
 const seo = await writr.ai.getSEO();
 console.log(seo.slug);              // "getting-started-with-writr"
-console.log(seo.canonical);         // "https://example.com/getting-started-with-writr"
 console.log(seo.openGraph?.title);  // "Getting Started with Writr"
 
 // Generate only a slug
 const seo = await writr.ai.getSEO({ slug: true });
 ```
 
-**Available fields:** `slug`, `canonical`, `openGraph` (includes `title`, `description`, `image`).
+**Available fields:** `slug`, `openGraph` (includes `title`, `description`, `image`).
 
 ## Translation
 

package/dist/writr.d.ts

@@ -26,6 +26,7 @@ type WritrOptions = {
  * @property {boolean} [gfm] - Github flavor markdown (default: true)
  * @property {boolean} [math] - Math support (default: true)
  * @property {boolean} [mdx] - MDX support (default: false)
+ * @property {boolean} [rawHtml] - Raw HTML passthrough (default: false)
  * @property {boolean} [caching] - Caching (default: true)
  */
 type RenderOptions = {
@@ -36,6 +37,7 @@ type RenderOptions = {
     gfm?: boolean;
     math?: boolean;
     mdx?: boolean;
+    rawHtml?: boolean;
     caching?: boolean;
 };
 /**
@@ -116,10 +118,6 @@ type WritrSEO = {
      * A URL-safe identifier for the document.
      */
     slug?: string;
-    /**
-     * The preferred canonical URL for the document.
-     */
-    canonical?: string;
     /**
      * Open Graph metadata used by social platforms.
      */
@@ -240,10 +238,6 @@ type WritrGetSEOOptions = {
      * Generate a URL-safe slug.
      */
     slug?: boolean;
-    /**
-     * Generate a canonical URL value.
-     */
-    canonical?: boolean;
     /**
      * Generate Open Graph metadata for the document.
      */

package/dist/writr.js

@@ -6,6 +6,7 @@ import parse from "html-react-parser";
 import * as yaml from "js-yaml";
 import rehypeHighlight from "rehype-highlight";
 import rehypeKatex from "rehype-katex";
+import rehypeRaw from "rehype-raw";
 import rehypeSlug from "rehype-slug";
 import rehypeStringify from "rehype-stringify";
 import remarkEmoji from "remark-emoji";
@@ -332,7 +333,7 @@ ${this.writr.content}`
     );
   }
   resolveSEOFields(options) {
-    const allFields = ["slug", "canonical", "openGraph"];
+    const allFields = ["slug", "openGraph"];
     if (!options) {
       return allFields;
     }
@@ -420,12 +421,6 @@ ${this.writr.content}`
         z.string().describe("A URL-safe identifier for the document")
       ]);
     }
-    if (fieldSet.has("canonical")) {
-      entries.push([
-        "canonical",
-        z.string().describe("The preferred canonical URL for the document")
-      ]);
-    }
     if (fieldSet.has("openGraph")) {
       entries.push([
         "openGraph",
@@ -467,6 +462,7 @@ var Writr = class extends Hookified {
       gfm: true,
       math: true,
       mdx: false,
+      rawHtml: false,
       caching: true
     }
   };
@@ -948,7 +944,23 @@ ${yamlString}---
     if (options.emoji) {
       processor.use(remarkEmoji);
     }
-    processor.use(remarkRehype);
+    if (options.mdx) {
+      processor.use(remarkMDX);
+    }
+    const rehypeOptions = {};
+    if (options.rawHtml) {
+      rehypeOptions.allowDangerousHtml = true;
+    }
+    if (options.mdx) {
+      rehypeOptions.handlers = {
+        mdxJsxFlowElement: mdxJsxHandler,
+        mdxJsxTextElement: mdxJsxHandler
+      };
+    }
+    processor.use(remarkRehype, rehypeOptions);
+    if (options.rawHtml) {
+      processor.use(rehypeRaw);
+    }
     if (options.slug) {
       processor.use(rehypeSlug);
     }
@@ -958,9 +970,6 @@ ${yamlString}---
     if (options.math) {
       processor.use(remarkMath).use(rehypeKatex);
     }
-    if (options.mdx) {
-      processor.use(remarkMDX);
-    }
     processor.use(rehypeStringify);
     return processor;
   }
@@ -986,12 +995,33 @@ ${yamlString}---
     if (options.mdx !== void 0) {
       current.mdx = options.mdx;
     }
+    if (options.rawHtml !== void 0) {
+      current.rawHtml = options.rawHtml;
+    }
     if (options.caching !== void 0) {
       current.caching = options.caching;
     }
     return current;
   }
 };
+function mdxJsxHandler(state, node) {
+  const properties = {};
+  for (const attr of node.attributes) {
+    if (attr.type === "mdxJsxAttribute") {
+      if (attr.value === null) {
+        properties[attr.name] = true;
+      } else if (typeof attr.value === "string") {
+        properties[attr.name] = attr.value;
+      }
+    }
+  }
+  return {
+    type: "element",
+    tagName: node.name ?? "div",
+    properties,
+    children: state.all(node)
+  };
+}
 export {
   Writr,
   WritrAI,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "writr",
-  "version": "6.0.0",
+  "version": "6.1.0",
   "description": "Markdown Rendering Simplified",
   "type": "module",
   "main": "./dist/writr.js",
@@ -58,6 +58,7 @@
     "react": "^19.2.4",
     "rehype-highlight": "^7.0.2",
     "rehype-katex": "^7.0.1",
+    "rehype-raw": "^7.0.0",
     "rehype-slug": "^6.0.0",
     "rehype-stringify": "^10.0.1",
     "remark-emoji": "^5.0.2",