0.1.6

.npmignore

@@ -0,0 +1,2 @@
+src
+node_modules

package-lock.json

@@ -29,7 +29,7 @@
         "@types/qrcode": "^1.5.0",
         "typescript": "^5.0.4"
       },
-      "version": "0.1.1"
+      "version": "0.1.6"
     },
     "node_modules/@tootallnate/once": {
       "version": "2.0.0",
@@ -3483,5 +3483,5 @@
       }
     }
   },
-  "version": "0.1.1"
+  "version": "0.1.6"
 }

package.json

@@ -1,16 +1,17 @@
 {
   "name": "@doc-utils/markdown2html",
-  "version": "0.1.1",
+  "version": "0.1.6",
   "publishConfig": {
     "registry": "https://gitea.home.jbrumond.me/api/packages/doc-utils/npm/"
   },
   "scripts": {
-    "tsc": "tsc"
+    "tsc": "tsc",
+    "clean": "rm -rf ./build"
   },
   "bin": {
     "markdown2html": "./bin/markdown2html"
   },
-  "exports": "./build/index.js",
+  "main": "./build/index.js",
   "devDependencies": {
     "@types/dompurify": "^2.3.3",
     "@types/jsdom": "^20.0.0",

readme.md

@@ -22,8 +22,11 @@ These are the primary projects used to render various types of content:
 # Update project npm config to refer to correct registry for the @doc-utils scope
 echo '@doc-utils:registry=https://gitea.jbrumond.me/api/packages/doc-utils/npm/' >> ./.npmrc
 
-# Install package
+# Install package for programatic use
 npm install --save @doc-utils/markdown2html
+
+# Install globally for CLI usage
+npm install --global @doc-utils/markdown2html
 ```
 
 
@@ -50,13 +53,13 @@ async function main() {
 }
 ```
 
-### Handling Frontmatter
+### Handling front matter
 
 ```ts
 import { process_frontmatter } from '@doc-utils/markdown2html';
 
 const raw_content = `---
-title: Example Markdown with Frontmatter
+title: Example Markdown with front matter
 foo:
 - bar
 - baz
@@ -65,11 +68,11 @@ foo:
 # This is some markdown
 `;
 
-const { frontmatter, markdown } = process_frontmatter(raw_content);
+const { frontmatter, document } = process_frontmatter(raw_content);
 
-console.log(frontmatter.title);  // "Example Markdown with Frontmatter"
+console.log(frontmatter.title);  // "Example Markdown with front matter"
 console.log(frontmatter.foo);    // [ "bar", "baz" ]
-console.log(markdown);           // "\n# This is some markdown\n"
+console.log(document);           // "\n# This is some markdown\n"
 ```
 
 
@@ -80,11 +83,11 @@ console.log(markdown);           // "\n# This is some markdown\n"
 echo '# This is some markdown' | ./bin/markdown2html --base-url 'https://example.com' > output.html
 ```
 
-### Handling Frontmatter
+### Handling front matter
 
 ```bash
 filecontents="---
-title: Example Markdown with Frontmatter
+title: Example Markdown with front matter
 foo:
 - bar
 - baz

src/frontmatter.ts

@@ -1,18 +1,26 @@
 
 import * as yaml from 'yaml';
 
-export function process_frontmatter(document: string, parse = true) {
+export function process_frontmatter(raw_document: string, parse = true) {
-	if (! document.startsWith('---\n')) {
+	if (! raw_document.startsWith('---\n')) {
 		return {
 			frontmatter: null,
-			markdown: document,
+			document: raw_document,
 		};
 	}
 
-	const endIndex = document.slice(3).indexOf('\n---\n') + 3;
+	const end_index = raw_document.slice(3).indexOf('\n---\n') + 3;
-	const frontmatterYaml = document.slice(3, endIndex);
-	const markdown = document.slice(endIndex + 4);
-	const frontmatter = parse ? frontmatterYaml : yaml.parse(frontmatterYaml);
 	
-	return { frontmatter, markdown };
+	if (end_index === 2) {
+		return {
+			frontmatter: null,
+			document: raw_document,
+		};
+	}
+
+	const formatter_yaml = raw_document.slice(3, end_index);
+	const document = raw_document.slice(end_index + 4);
+	const frontmatter = parse ? formatter_yaml : yaml.parse(formatter_yaml);
+
+	return { frontmatter, document };
 }