writr 6.1.0 → 6.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +3 -3
  2. package/package.json +14 -14
package/README.md CHANGED
@@ -199,13 +199,13 @@ Accessing the default options for this instance of Writr. Here is the default se
199
199
  }
200
200
  ```
201
201
 
202
- 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.
202
+ By default, raw HTML in markdown (such as `&lt;iframe&gt;`, `&lt;video&gt;`, or `&lt;div&gt;` 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.
203
203
 
204
204
  **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.
205
205
 
206
206
  ## `.frontmatter`
207
207
 
208
- Accessing the frontmatter for this instance of Writr. This is a `Record<string, any>` and can be set via the `.content` property.
208
+ Accessing the frontmatter for this instance of Writr. This is a `Record&lt;string, any&gt;` and can be set via the `.content` property.
209
209
 
210
210
  ```javascript
211
211
  import { Writr } from 'writr';
@@ -255,7 +255,7 @@ const html = await writr.render(options); // <h1>Hello World ::-):</h1><p>This i
255
255
 
256
256
  ## `.engine`
257
257
 
258
- Accessing the underlying engine for this instance of Writr. This is a `Processor<Root, Root, Root, undefined, undefined>` from the core [`unified`](https://github.com/unifiedjs/unified) project and uses the familiar `.use()` plugin pattern. You can chain additional unified plugins on this processor to customize the render pipeline. Learn more about the unified engine at [unifiedjs.com](https://unifiedjs.com/) and check out the [getting started guide](https://unifiedjs.com/learn/guide/using-unified/) for examples.
258
+ Accessing the underlying engine for this instance of Writr. This is a `Processor&lt;Root, Root, Root, undefined, undefined&gt;` from the core [`unified`](https://github.com/unifiedjs/unified) project and uses the familiar `.use()` plugin pattern. You can chain additional unified plugins on this processor to customize the render pipeline. Learn more about the unified engine at [unifiedjs.com](https://unifiedjs.com/) and check out the [getting started guide](https://unifiedjs.com/learn/guide/using-unified/) for examples.
259
259
 
260
260
 
261
261
  ## `.render(options?: RenderOptions)`
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "writr",
3
- "version": "6.1.0",
3
+ "version": "6.1.1",
4
4
  "description": "Markdown Rendering Simplified",
5
5
  "type": "module",
6
6
  "main": "./dist/writr.js",
@@ -49,9 +49,9 @@
49
49
  "markdown-to-react"
50
50
  ],
51
51
  "dependencies": {
52
- "ai": "^6.0.116",
53
- "cacheable": "^2.3.3",
54
- "hashery": "^1.5.0",
52
+ "ai": "^6.0.138",
53
+ "cacheable": "^2.3.4",
54
+ "hashery": "^1.5.1",
55
55
  "hookified": "^2.1.0",
56
56
  "html-react-parser": "^5.2.17",
57
57
  "js-yaml": "^4.1.1",
@@ -73,26 +73,26 @@
73
73
  "zod": "^4.3.6"
74
74
  },
75
75
  "devDependencies": {
76
- "@ai-sdk/anthropic": "^3.0.58",
77
- "@ai-sdk/google": "^3.0.43",
78
- "@ai-sdk/openai": "^3.0.41",
79
- "@biomejs/biome": "^2.4.7",
76
+ "@ai-sdk/anthropic": "^3.0.64",
77
+ "@ai-sdk/google": "^3.0.53",
78
+ "@ai-sdk/openai": "^3.0.48",
79
+ "@biomejs/biome": "^2.4.8",
80
80
  "@monstermann/tinybench-pretty-printer": "^0.3.0",
81
81
  "@types/js-yaml": "^4.0.9",
82
82
  "@types/markdown-it": "^14.1.2",
83
83
  "@types/node": "^25.5.0",
84
84
  "@types/react": "^19.2.14",
85
- "@vitest/coverage-v8": "^4.1.0",
86
- "docula": "^0.40.0",
85
+ "@vitest/coverage-v8": "^4.1.1",
86
+ "docula": "^1.10.0",
87
87
  "dotenv": "^17.3.1",
88
88
  "markdown-it": "^14.1.1",
89
- "marked": "^17.0.4",
89
+ "marked": "^17.0.5",
90
90
  "rimraf": "^6.1.3",
91
91
  "tinybench": "^6.0.0",
92
92
  "tsup": "^8.5.1",
93
93
  "tsx": "^4.21.0",
94
94
  "typescript": "^5.9.3",
95
- "vitest": "^4.1.0"
95
+ "vitest": "^4.1.1"
96
96
  },
97
97
  "files": [
98
98
  "dist",
@@ -107,7 +107,7 @@
107
107
  "test": "pnpm lint && vitest run --coverage",
108
108
  "test:ci": "biome check --error-on-warnings && vitest run --coverage",
109
109
  "test:integration": "vitest run --config vitest.integration.config.ts",
110
- "website:build": "rimraf ./site/README.md ./site/dist && npx docula build -s ./site -o ./site/dist",
111
- "website:serve": "rimraf ./site/README.md ./site/dist && npx docula serve -s ./site -o ./site/dist"
110
+ "website:build": "rimraf ./site/README.md ./site/dist && pnpm docula build",
111
+ "website:serve": "rimraf ./site/README.md ./site/dist && pnpm docula dev"
112
112
  }
113
113
  }