markdown2typst 0.1.1 → 0.1.3

package/README.md

@@ -2,8 +2,8 @@
 
 A JavaScript library for converting Markdown to [Typst](https://typst.app/) code.
 
-## Try it online (PENDING!!!)
-See an example use case in this demo website: [https://markdown2typst.vercel.app](https://markdown2typst.vercel.app).
+## Demo - Try it online
+See as an example use case the [demo](./demo/) of this repository published as a static website: [https://Mapaor.github.io/markdown2typst](https://Mapaor.github.io/markdown2typst).
 
 ## Supported Markdown features
 ### GitHub Flavored Markdown (GFM)
@@ -100,7 +100,7 @@ Note: any non-standard key is simply ignored, all keys are optional. The front-m
 ### NPM package (for Node.js projects)
 Package link:
 
-[](https://www.npmjs.com/package/markdown2typst)
+[https://www.npmjs.com/package/markdown2typst](https://www.npmjs.com/package/markdown2typst)
 
 Install it:
 
@@ -141,26 +141,46 @@ A javascript bundle will appear in the `dist` folder. Make the desired changes t
 npm run test
 ```
 
+## Simple Usage
 
-## Usage
+#### Using the package
 
-### Simple usage
+##### Simplest example
+```javascript
+import { markdown2typst } from 'markdown2typst';
 
-#### Using the bundle
+const markdown = '# Hello Typst\n\nThis is a **test**.';
+const typst = markdown2typst(markdown);
+console.log(typst);
+```
+
+##### Converting a Markdown file
+```js
+import { markdown2typst } from 'markdown2typst';
+import { readFileSync } from 'fs';
 
-##### In Node.js (ESM) - Locally
+const markdown = readFileSync('./example-file.md', 'utf-8');
+const typst = markdown2typst(markdown);
+console.log(typst);
+```
+
+#### Using the bundle - Locally
+
+Suppose you've downloaded the JS bundle and saved it in a `assets` folder, now for using it in your website you would simply do:
+
+##### In Node.js (ESM)
 ```javascript
-import { markdown2typst } from './dist/markdown2typst.min.js';
+import { markdown2typst } from './assets/markdown2typst.min.js';
 
 const markdown = '# Hello Typst\n\nThis is a **test**.';
 const typst = markdown2typst(markdown);
 console.log(typst);
 ```
 
-##### In the browser - Locally
+##### In the browser
 ```html
 <script type="module">
-  import { markdown2typst } from './dist/markdown2typst.min.js';
+  import { markdown2typst } from './assets/markdown2typst.min.js';
   
   const markdown = '# Hello Typst';
   const typst = markdown2typst(markdown);
@@ -168,6 +188,27 @@ console.log(typst);
 </script>
 ```
 
+#### Using the bundle - Via CDN
+
+```html
+<script src="https://cdn.jsdelivr.net/npm/markdown2typst@latest/dist/markdown2typst.min.js"></script>
+<script>
+  const markdown = '# Hello Typst\n\nThis is a **test**.';
+  const typst = markdown2typst(markdown);
+  console.log(typst);
+</script>
+```
+
+#### Or in a javascript file
+```js
+import markdown2typst from 'https://cdn.jsdelivr.net/npm/markdown2typst@latest/dist/markdown2typst.min.js';
+
+const markdown = '# Hello Typst\n\nThis is a **test**.';
+const typst = markdown2typst(markdown);
+console.log(typst);
+```
+
+Which is what the [demo](./demo/) uses.
 ## Examples
 
 See the [Examples](/examples/README.md) page for basic and advanced examples on how to use the library and all the features it supports.

package/dist/markdown2typst.js

@@ -20455,8 +20455,10 @@ function markdown2typst(markdown, options = {}) {
     throw error;
   }
 }
+var markdown2typst_default = markdown2typst;
 export {
   ErrorSeverity,
+  markdown2typst_default as default,
   markdown2typst
 };
 /**