local.js: Move markdown_extend out of local config file

Author: slusarz

.vitepress/local.js.dist

@@ -12,22 +12,3 @@
 export const data_paths = {
 	// doveadm: '../data/doveadm.js',
 }
-
-// Enable additional labels to support in Dovecot-specific markdown
-// processing (i.e. [[xyz,...]]).
-export const markdown_extend = {
-
-	// Init function. Return value is configuration options to add to markdown
-	// object.
-	// init: () => { return {} },
-
-	// Opening tag function. Returns opening tag.
-	// open: (mode, parts, opts, env) => { return '' },
-
-	// Body function. Returns body text.
-	// body: (mode, env) => { return '' },
-
-	// Close tag function. Returns closing tag.
-	// close: (mode, env) => { return '' },
-
-}

README.md

@@ -176,6 +176,29 @@ Paths are relative to project base.
 
 Supports fast-glob: https://github.com/mrmlnc/fast-glob#pattern-syntax
 
+#### markdown_extend
+
+An object containing callbacks that enable additional labels to support in
+Dovecot-specific markdown processing (i.e. [[xyz,...]]).
+
+##### open
+
+Opening tag function. Returns opening tag.
+
+Example: `open: (mode, parts, opts, env) => { return '' }`
+
+##### body
+
+Body function. Returns body text.
+
+Example: `body: (mode, env) => { return '' }`
+
+##### close
+
+Close tag function. Returns closing tag.
+
+Example: `close: (mode, env) => { return '' }`
+
 #### plugin_paths
 
 A listing of paths containing plugin files.

lib/markdown.js

@@ -3,7 +3,7 @@ import fg from 'fast-glob'
 import deflistPlugin from 'markdown-it-deflist'
 import path from 'path'
 import { createMarkdownRenderer } from 'vitepress'
-import { dovecotSetting, frontmatterIter, loadData, markdownExtension, resolveURL } from './utility.js'
+import { dovecotSetting, frontmatterIter, loadData, resolveURL } from './utility.js'
 
 let md_conf = null
 export async function initDovecotMd(base) {
@@ -12,15 +12,12 @@ export async function initDovecotMd(base) {
 	}
 
 	md_conf = {
-		...{
-			base: base,
-			doveadm: (await loadData('doveadm')).doveadm,
-			events: (await loadData('events')).events,
-			linkoverrides: (await loadData('links_overrides')).links_overrides,
-			settings: (await loadData('settings')).settings,
-			updates: (await loadData('updates')).updates
-		},
-		...(await markdownExtension())
+		base: base,
+		doveadm: (await loadData('doveadm')).doveadm,
+		events: (await loadData('events')).events,
+		linkoverrides: (await loadData('links_overrides')).links_overrides,
+		settings: (await loadData('settings')).settings,
+		updates: (await loadData('updates')).updates
 	}
 }
 
@@ -291,6 +288,8 @@ function dovecot_markdown(md, opts) {
 					opts.base) + '">'
 
 		default:
+			initMarkdownExtend()
+
 			return handle_default(mode,
 				opts.markdown?.open?.(mode, parts, opts, env))
 		}
@@ -432,6 +431,12 @@ function dovecot_markdown(md, opts) {
 		}
 	}
 
+	function initMarkdownExtend() {
+		if (!opts.markdown) {
+			opts.markdown = dovecotSetting('markdown_extend') ?? {}
+		}
+	}
+
 	function initPluginFiles() {
 		if (!opts.plugins) {
 			opts.plugins = dovecotSetting('plugin_paths').flatMap((x) =>

lib/utility.js

@@ -41,17 +41,6 @@ async function loadLocalConf() {
 	return local_conf
 }
 
-export async function markdownExtension() {
-	const lconf = await loadLocalConf()
-
-	return {
-		...{
-			markdown: lconf.markdown_extend ?? {},
-		},
-		...(lconf.markdown_extend?.init?.() ?? {})
-	}
-}
-
 export async function loadData(id) {
 	/* Check for config override file. */
 	const lconf = await loadLocalConf()