0.1.21

bin/markdown2html

@@ -1,2 +1,2 @@
 #!/bin/sh
-node $(dirname $0)/markdown2html.js $*
+node $(dirname "$(readlink -f "$0")")/markdown2html.js $*

bin/strip-frontmatter

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

package-lock.json

@@ -1,12 +1,12 @@
 {
   "name": "@doc-utils/markdown2html",
-  "version": "0.1.13",
+  "version": "0.1.21",
   "lockfileVersion": 2,
   "requires": true,
   "packages": {
     "": {
       "name": "@doc-utils/markdown2html",
-      "version": "0.1.13",
+      "version": "0.1.21",
       "dependencies": {
         "bytefield-svg": "^1.6.1",
         "dompurify": "^2.3.6",

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@doc-utils/markdown2html",
-  "version": "0.1.13",
+  "version": "0.1.21",
   "publishConfig": {
     "registry": "https://gitea.home.jbrumond.me/api/packages/doc-utils/npm/"
   },

src/breadcrumb-nav.ts

@@ -0,0 +1,64 @@
+
+import { marked } from 'marked';
+import { ParsedAttributes, parse_attributes } from './attrs';
+import { MarkdownOptions } from './render';
+
+// todo: deprecate this
+
+export interface BreadcrumbNavToken extends marked.Tokens.Generic {
+	text: string;
+	attrs: ParsedAttributes;
+	items: marked.Token[][];
+}
+
+export function breadcrumb_nav_ext(renderer: marked.Renderer, opts: MarkdownOptions) : marked.TokenizerExtension & marked.RendererExtension {
+	return {
+		name: 'breadcrumb_nav',
+		level: 'block',
+		start: (src) => src.match(/^\/\/\//)?.index,
+		tokenizer(src, tokens) {
+			const rule = /^\/\/\/(\/*)([^\n]+)?(?:\n)((?:[^\/]|\/\/?(?!\/\1))+)\/\/\/\1/;
+			const match = rule.exec(src);
+
+			if (match) {
+				const token: BreadcrumbNavToken = {
+					type: 'breadcrumb_nav',
+					raw: match[0],
+					text: match[3],
+					attrs: parse_attributes(match[2] || ''),
+					tokens: [ ],
+					items: [ ],
+				};
+
+				const lines = match[3].trim().split('\n');
+
+				for (const line of lines) {
+					const tokens = this.lexer.inlineTokens(line, [ ]);
+					token.tokens.push(...tokens);
+					token.items.push(tokens);
+				}
+
+				return token;
+			}
+		},
+		renderer(token: BreadcrumbNavToken) {
+			return `<nav aria-label="breadcrumbs" ${token.attrs.html_attrs.join(' ')}>\n`
+				+ `\t<ol>\n`
+				+ '\t\t'
+					+ token.items.map((tokens, index) =>{ 
+						let item = '<li>\n';
+
+						if (index) {
+							item += '\t\t\t<span class="separator" aria-hidden="true">/</span>\n';
+						}
+
+						item += `\t\t\t${this.parser.parseInline(tokens, renderer)}\n`;
+
+						return item + '\t\t</li>';
+					}).join('\n\t\t')
+				+ '\n'
+				+ `\t</ol>\n`
+				+ `</nav>`;
+		}
+	};
+}

src/html-sanitize.ts

@@ -8,6 +8,6 @@ export function sanitize_html(html: string, custom_elements?: CustomElementHandl
 	const { window } = new JSDOM('');
 	const dom_purify = createDOMPurify(window as any as Window);
 	return dom_purify.sanitize(html, {
-		CUSTOM_ELEMENT_HANDLING: custom_elements
+		CUSTOM_ELEMENT_HANDLING: custom_elements,
 	});
 }

src/index.ts

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

src/render.ts

@@ -9,6 +9,7 @@ import { katex_block_ext, katex_inline_ext } from './katex';
 import { footnote_list_ext, footnote_ref_ext } from './footnotes';
 import { description_list_ext } from './description-list';
 import { resolve_async_bindings } from './async-steps';
+import { breadcrumb_nav_ext } from './breadcrumb-nav';
 
 export interface MarkdownOptions {
 	base_url?: string;
@@ -40,6 +41,7 @@ export async function render_markdown_to_html(markdown: string, options: Markdow
 			description_list_ext(marked_options.renderer, options),
 			section_ext(marked_options.renderer, options),
 			icon_ext(marked_options.renderer, options),
+			breadcrumb_nav_ext(marked_options.renderer, options),
 			...(options.extensions || [ ]).map((ext) => {
 				return ext(marked_options.renderer, options);
 			}),
@@ -67,3 +69,38 @@ export async function render_markdown_to_html(markdown: string, options: Markdow
 
 	return sanitize_html(unsafe_html, options.custom_elements);
 }
+
+export function render_markdown_to_html_inline_sync(markdown: string, options: MarkdownOptions = { }) {
+	const marked_options: marked.MarkedOptions = {
+		baseUrl: options.base_url,
+		breaks: options.breaks || false,
+		renderer: create_renderer(options),
+	};
+
+	marked.use({
+		extensions: [
+			katex_block_ext(marked_options.renderer, options),
+			katex_inline_ext(marked_options.renderer, options),
+			footnote_ref_ext(marked_options.renderer, options),
+			footnote_list_ext(marked_options.renderer, options),
+			mark_ext(marked_options.renderer, options),
+			description_list_ext(marked_options.renderer, options),
+			section_ext(marked_options.renderer, options),
+			icon_ext(marked_options.renderer, options),
+			breadcrumb_nav_ext(marked_options.renderer, options),
+			...(options.extensions || [ ]).map((ext) => {
+				return ext(marked_options.renderer, options);
+			}),
+		],
+		tokenizer: {
+			url(src) {
+				// disable auto-linking; more can be added here to auto-link only sometimes
+				// see: https://github.com/markedjs/marked/issues/882#issuecomment-781628889
+				return null;
+			}
+		},
+	});
+	
+	const unsafe_html = marked.parseInline(markdown, marked_options);
+	return sanitize_html(unsafe_html, options.custom_elements);
+}

src/renderer.ts

@@ -197,7 +197,7 @@ function code(renderer: marked.Renderer, opts: MarkdownOptions) {
 
 const arg_pattern = /^(?:[a-zA-Z0-9_:-]+|"(?:[^"\n]|(?<=\\)")*")/;
 
-function parse_code_args(text: string) {
+function parse_code_args(text = '') {
 	const args: string[] = [ ];
 
 	text = text.trim();