markdown2typst 0.1.0 → 0.1.2

package/README.md

@@ -2,7 +2,7 @@
 
 A JavaScript library for converting Markdown to [Typst](https://typst.app/) code.
 
-## Try it online
+## Try it online (PENDING!!!)
 See an example use case in this demo website: [https://markdown2typst.vercel.app](https://markdown2typst.vercel.app).
 
 ## Supported Markdown features
@@ -98,6 +98,11 @@ Note: any non-standard key is simply ignored, all keys are optional. The front-m
 ## Installation
 
 ### NPM package (for Node.js projects)
+Package link:
+
+[https://www.npmjs.com/package/markdown2typst](https://www.npmjs.com/package/markdown2typst)
+
+Install it:
 
 ```bash
 npm install tex2typst
@@ -105,28 +110,16 @@ npm install tex2typst
 
 ### JS Bundle
 
-Available both on JSDeliver and Unpkg.
-
 #### JSDelivr
 
-##### JSDelivr NPM 
-
-```
-<script src="https://cdn.jsdelivr.net/npm/..."></script>
-```
-
-##### JSDelivr GitHub Link
-
 ```
-<script src="https://cdn.jsdelivr.net/gh/..."></script>
+<script src="https://cdn.jsdelivr.net/npm/markdown2typst@latest/dist/markdown2typst.min.js"></script>
 ```
 
-The link points to the `markdown2typst.min.js` file of this repository (inside the `dist` folder).
-
-#### Unpkg (NPM link)
+#### Unpkg
 
 ```
-<script src="https://unpkg.com/..."></script>
+<script src="https://unpkg.com/markdown2typst@latest/dist/markdown2typst.min.js"></script>
 ```
 
 ### Build from source
@@ -138,33 +131,56 @@ cd markdown2typst
 
 # Install dependencies
 npm install
-```
-Make the desired changes to the library (`markdown2typst.ts` file) and then build from source
-```bash
+
 # Build the bundle
 npm run build
 ```
-The updated javascript bundle will appear in the `dist` folder.
+A javascript bundle will appear in the `dist` folder. Make the desired changes to the library and then build again if you need. To test your modifications still comply with what's expected from the library run the tests.
+```bash
+# Testing
+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);
+```
 
-##### In Node.js (ESM) - Locally
+##### Converting a Markdown file
+```js
+import { markdown2typst } from 'markdown2typst';
+import { readFileSync } from 'fs';
+
+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);
@@ -172,30 +188,20 @@ console.log(typst);
 </script>
 ```
 
+#### Using the bundle - Via CDN
 
-#### Using the library - Locally
-
-```typescript
-import { markdown2typst } from './src/markdown2typst';
-
-const markdown = `
-# My Document
-
-This is a paragraph with **bold** and *italic* text.
-
-## Features
-
-- Item 1
-- Item 2
-`;
-
-const typst = markdown2typst(markdown);
-console.log(typst);
+```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>
 ```
 
-### Advanced usage
+## Examples
 
-See the [Examples](/examples/README.md) page for advanced examples on how to use the library.
+See the [Examples](/examples/README.md) page for basic and advanced examples on how to use the library and all the features it supports.
 
 ## Internal architecture
 Check the [Architecture](./ARCHITECTURE.md) doc for getting a better understanding of how the library works under the hood.
@@ -218,15 +224,16 @@ Built thanks to the following open-source projects:
   - [remark-parse](https://github.com/remarkjs/remark/tree/main)
 - [esbuild](https://esbuild.github.io/) - Fast bundler
 - [tex2typst](https://github.com/qwinsi/tex2typst) - Typst conversion for LaTeX equations
+- [js-yaml](https://github.com/nodeca/js-yaml) - YAML parser
 
-This code is mainly based on the code by zhaoyiqun (@cosformula on GitHub), more specifically in his [markdownToTypst.ts](https://github.com/cosformula/mdxport/blob/main/src/lib/pipeline/markdownToTypst.ts) custom conversion library (renderer to Typst code) built for his open source project [MDXport](https://mdxport.com).
+This code was initially based on the code by zhaoyiqun (@cosformula on GitHub), more specifically in his [markdownToTypst.ts](https://github.com/cosformula/mdxport/blob/main/src/lib/pipeline/markdownToTypst.ts) custom conversion library (renderer to Typst code) built for his open source project [MDXport](https://mdxport.com).
 
 ## Roadmap
 
 - [X] Finish an initial working version
 - [X] Add frontmatter support and also allow to pass the keys as custom options of the main function
-- [ ] Publish to npm
-- [ ] Add a comprehensive test suite
+- [X] Publish to npm
+- [X] Add a comprehensive test suite
 - [ ] Add CLI tool
 - [ ] Support custom templates
 - [ ] Support more Markdown extensions/flavors/specs

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
 };
 /**