support for stripping off frontmatter

bin/strip-frontmatter

@@ -0,0 +1,2 @@
+#!/bin/sh
+node $(dirname $0)/strip-frontmatter.js $*

bin/strip-frontmatter.js

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+require('../build/bin/strip-frontmatter.js');

readme.md

@@ -38,6 +38,28 @@ async function main() {
 }
 ```
 
+### Handling Frontmatter
+
+```ts
+import { process_frontmatter } from './build';
+
+const raw_content = `---
+title: Example Markdown with Frontmatter
+foo:
+- bar
+- baz
+---
+
+# This is some markdown
+`;
+
+const { frontmatter, markdown } = process_frontmatter(raw_content);
+
+console.log(frontmatter.title);  // "Example Markdown with Frontmatter"
+console.log(frontmatter.foo);    // [ "bar", "baz" ]
+console.log(markdown);           // "\n# This is some markdown\n"
+```
+
 
 
 ## Command Line Use
@@ -46,6 +68,22 @@ async function main() {
 echo '# This is some markdown' | ./bin/markdown2html --base-url 'https://example.com' > output.html
 ```
 
+### Handling Frontmatter
+
+```bash
+filecontents="---
+title: Example Markdown with Frontmatter
+foo:
+- bar
+- baz
+---
+
+# This is some markdown
+"
+
+echo "$filecontents" | ./bin/strip-frontmatter frontmatter.json > markdown.md
+```
+
 
 
 ## Options

src/bin/strip-frontmatter.ts

@@ -0,0 +1,2 @@
+
+console.log('strip-frontmatter');

src/frontmatter.ts

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

src/index.ts

@@ -1,2 +1,3 @@
 
-export * from './render';
+export { process_frontmatter } from './frontmatter';
+export { render_markdown_to_html, MarkdownExtension, MarkdownOptions } from './render';