remark-inline-svg-flex 0.2.3 → 0.3.3

package/README.md

@@ -61,16 +61,21 @@ This is a test markdown document.
 ![some svg](some.svg)
 ```
 
-And our module `example.js` looks as follows:
+And our module `example.js` looks as the one below. It is recommended to pass
+the markdown directory path to `process()` so that the plugin can resolve relative
+paths correctly.
 
 ```js
 import { remark } from 'remark';
 import { readFile } from 'node:fs/promises';
-import { inlineSvg } from 'remark-inline-svg-flex';
+import { remarkInlineSvg } from 'remark-inline-svg-flex';
 
 const markdown = await readFile(_path, { encoding: 'utf8' });
 
-return await remark().use(remarkParse).use(inlineSvg).process(markdown);
+return await remark()
+  .use(remarkParse)
+  .use(remarkInlineSvg)
+  .process({ value: markdown, path: _path });
 ```
 
 Now running `node example.js` yields:
@@ -120,5 +125,5 @@ The SVG's are optimized by default. Disable it by setting it to `false`.
 ## SVGO configuration
 
 ```
-{ plugins: ['preset-default', 'removeXMLNS', 'removeDimensions'] }
+{ plugins: ['preset-default', 'removeXMLNS'] }
 ```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "remark-inline-svg-flex",
-  "version": "0.2.3",
+  "version": "0.3.3",
   "description": "Flexible Remark plugin that inlines and optimizes SVGs with SVGO, featuring customizable path resolution and wrappers.",
   "keywords": [
     "unified",
@@ -48,11 +48,11 @@
     "rimraf": "^6.1.3",
     "typescript": "^5.9.3",
     "unified": "^11.0.5",
-    "vfile": "^6.0.3",
     "vitest": "^4.1.0"
   },
   "dependencies": {
     "svgo": "^4.0.1",
-    "unist-util-visit": "^5.1.0"
+    "unist-util-visit": "^5.1.0",
+    "vfile": "^6.0.3"
   }
 }