local.js: Move data_paths out of local config file

Author: slusarz

.vitepress/config.js

@@ -2,16 +2,11 @@ import gitCommitInfo from 'git-commit-info'
 import { defineConfig } from 'vitepress'
 import { pagefindPlugin } from 'vitepress-plugin-pagefind'
 import { generateSidebar } from 'vitepress-sidebar'
-import { dovecotMdExtend, initDovecotMd } from '../lib/markdown.js'
+import { dovecotMdExtend } from '../lib/markdown.js'
 import { getExcludes } from '../lib/utility.js'
 
 const base = '/2.4'
 
-// Need to bootstrap configuration for Dovecot markdown driver (specifically,
-// loading all data files to allow existence checking), or else the markdown
-// processing will begin before Dovecot link markup is enabled
-await initDovecotMd(base)
-
 export default defineConfig({
 	title: "Dovecot CE",
 	description: "Dovecot CE Documentation",
@@ -107,6 +102,16 @@ export default defineConfig({
 
 		/* Dovecot VitePress paths. */
 		dovecot: {
+			data_paths: {
+				doveadm: '../data/doveadm.js',
+				event_categories: '../data/event_categories.js',
+				event_reasons: '../data/event_reasons.js',
+				events: '../data/events.js',
+				links_overrides: '../data/links_overrides.js',
+				lua: '../data/lua.js',
+				settings: '../data/settings.js',
+				updates: '../data/updates.js',
+			},
 			man_includes: [
 				'docs/core/man/include/*.inc'
 			],
@@ -125,7 +130,7 @@ export default defineConfig({
 	},
 
 	markdown: {
-		config: (md) => dovecotMdExtend(md),
+		config: async (md) => await dovecotMdExtend(md),
 		image: {
 			lazyLoading: true,
 		},

.vitepress/local.js.dist

@@ -164,6 +164,16 @@ Additional configuration options required for VitePress static generation are
 defined using the `dovecot` object in the `themeConfig` VitePress
 configuration setting.
 
+#### data_paths
+
+Allows custom mapping of data sources.
+
+It is used by the VitePress data loaders to determine what data to
+load for export.
+
+Keys are data identifiers, Values are location RELATIVE TO `<base>/lib`
+DIRECTORY.
+
 #### man_includes
 
 A list of additional paths (other than the `include/` directory of the man

README.md

@@ -6,22 +6,7 @@ import { createMarkdownRenderer } from 'vitepress'
 import { dovecotSetting, frontmatterIter, loadData, resolveURL } from './utility.js'
 
 let md_conf = null
-export async function initDovecotMd(base) {
-	if (md_conf !== null) {
-		return
-	}
-
-	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
-	}
-}
-
-export function dovecotMdExtend(md) {
+export async function dovecotMdExtend(md) {
 	md.use(containerPlugin, 'todo', {
 		render: function(tokens, idx) {
 			if (tokens[idx].nesting === 1) {
@@ -34,7 +19,14 @@ export function dovecotMdExtend(md) {
 	md.use(deflistPlugin)
 
 	if (md_conf === null) {
-		throw new Error('Must call initDovecotMd() before calling this function!')
+		md_conf = {
+			base: globalThis.VITEPRESS_CONFIG.site.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
+		}
 	}
 	md.use(dovecot_markdown, md_conf)
 
@@ -46,8 +38,7 @@ export async function getVitepressMd() {
 	if (vitepress_md === null) {
 		const config = globalThis.VITEPRESS_CONFIG
 
-		await initDovecotMd(config.site.base)
-		vitepress_md = dovecotMdExtend(await createMarkdownRenderer(
+		vitepress_md = await dovecotMdExtend(await createMarkdownRenderer(
 			config.srcDir,
 			config.markdown,
 			config.site.base,

lib/markdown.js

@@ -42,10 +42,8 @@ async function loadLocalConf() {
 }
 
 export async function loadData(id) {
-	/* Check for config override file. */
-	const lconf = await loadLocalConf()
-	const path = lconf?.data_paths?.[id] ??
-		('../data/' + id + '.js')
+	const path = globalThis.VITEPRESS_CONFIG.userConfig.themeConfig.dovecot?.data_paths?.[id]
+		?? ('../data/' + id + '.js')
 
 	try {
 		return await import(__dirname + '/' + path)