Add Markdown example.

westy92 · May 12, 2021 · 1b394a0 · 1b394a0
1 parent 6f803c4
commit 1b394a0
Show file tree

Hide file tree

Showing 3 changed files with 89 additions and 74 deletions.
diff --git a/README.md b/README.md
@@ -116,6 +116,20 @@ const url = 'https://github.com/westy92/html-pdf-chrome';
 const pdf = await htmlPdf.create(url, options);
 ```
 
+### Using Markdown
+
+```js
+import * as htmlPdf from 'html-pdf-chrome';
+import * as marked from 'marked';
+
+const options: htmlPdf.CreateOptions = {
+  port: 9222, // port Chrome is listening on
+};
+
+const html = marked('# Hello [World](https://www.google.com/)!');
+const pdf = await htmlPdf.create(html, options);
+```
+
 ### Using a Template Engine
 
 Pug (formerly known as Jade)

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -31,6 +31,7 @@
     "windows",
     "mac",
     "linux",
+    "markdown",
     "nodejs"
   ],
   "license": "MIT",