@life-and-dev/mdsite 0.6.0 → 0.7.0

package/mdsite-nuxt/utils/mdsite-config.ts

@@ -26,25 +26,52 @@ export type MdsiteMenuItem = string | null | MdsiteMenuGroup
 export type MdsiteMenuGroup = { [key: string]: MdsiteMenuValue }
 export type MdsiteMenuValue = string | null | MdsiteMenuItem[]
 
+/**
+ * Footer items mirror the `menu` shape but with no nested sub-menus. Each item
+ * is one of:
+ *   - a bare markdown file name (string) — title is read from the file's H1
+ *   - `null` — rendered as a vertical separator
+ *   - a single-key object — the key is the link text, the value is either an
+ *     internal markdown path or an external URL (http/https)
+ *
+ * Lives under `features.footer` in `mdsite.yml`. Keep this type in sync with
+ * the CLI's `FooterItem` in `src/config/mdsite-config.ts`.
+ */
+export type MdsiteFooterItem = string | null | { [key: string]: string | null }
+
 export interface MdsiteConfig {
-  content?: {
-    path?: string
-  }
-  favicon: string
   features: {
     bibleTooltips: boolean
-    sourceEdit: boolean
+    /**
+     * URL prefix used to build the "Edit on …" link for a content page.
+     * The renderer appends `<contentPath>.md` to this prefix, so it must
+     * already include any path segment between the host and the content
+     * file (e.g. `https://github.com/org/repo/edit/main/`). An empty
+     * string disables the link.
+     */
+    sourceEdit: string
+    /**
+     * Footer items mirror the `menu` shape but with no nested sub-menus. Each
+     * item is one of:
+     *   - a bare markdown file name (string) — title is read from the file's H1
+     *   - `null` — rendered as a vertical separator
+     *   - a single-key object — the key is the link text, the value is either
+     *     an internal markdown path or an external URL (http/https)
+     *
+     * Lives under `features.footer` in `mdsite.yml`. Keep this in sync with
+     * the CLI's `FooterItem` in `src/config/mdsite-config.ts`.
+     */
+    footer: MdsiteFooterItem[]
   }
   menu: MdsiteMenuItem[]
-  footer: string[]
-  server: {
+  paths: {
+    input: string
+    build: string
     output: string
-    path: string
-    repo: string
-    gitBranch: string
   }
   site: {
     canonical: string
+    favicon: string
     name: string
   }
   themes: {
@@ -190,8 +217,8 @@ export function resolveContentDir(options: {
 
   if (resolvedConfigPath) {
     const configDir = path.dirname(resolvedConfigPath);
-    const contentPath = resolveContentConfigPath(rawConfig.content);
-    return contentPath ? path.resolve(configDir, contentPath) : configDir;
+    const inputPath = resolveInputConfigPath(rawConfig.paths?.input);
+    return inputPath ? path.resolve(configDir, inputPath) : configDir;
   }
 
   if (options.searchFrom) {
@@ -202,40 +229,58 @@ export function resolveContentDir(options: {
 }
 
 /**
- * Extract the content path from either the shorthand string form
- * (`content: docs`) or the explicit object form (`content:\n  path: docs`).
- * Returns undefined when no usable path is configured.
+ * Extract the content path from `paths.input`. Returns undefined when no
+ * usable path is configured.
  */
-function resolveContentConfigPath(rawContent: unknown): string | undefined {
-  if (typeof rawContent === 'string') {
-    const trimmed = rawContent.trim();
+function resolveInputConfigPath(rawInput: unknown): string | undefined {
+  if (typeof rawInput === 'string') {
+    const trimmed = rawInput.trim();
     return trimmed.length > 0 ? trimmed : undefined;
   }
 
-  if (rawContent && typeof rawContent === 'object' && typeof (rawContent as { path?: unknown }).path === 'string') {
-    return (rawContent as { path: string }).path;
+  if (rawInput && typeof rawInput === 'object' && typeof (rawInput as { path?: unknown }).path === 'string') {
+    return (rawInput as { path: string }).path;
   }
 
   return undefined;
 }
 
+/**
+ * Runtime type-guard for entries inside the `footer:` YAML list. Accepts:
+ *   - non-empty strings (file names / external URLs)
+ *   - `null` (separator)
+ *   - single-key objects whose value is a string or `null`
+ * Drops anything else silently to stay backwards-compatible with malformed
+ * user input; the CLI mirrors this filter.
+ */
+function isValidFooterItem(item: unknown): item is MdsiteFooterItem {
+  if (item === null) return true
+  if (typeof item === 'string') return item.trim().length > 0
+  if (typeof item === 'object') {
+    const keys = Object.keys(item as Record<string, unknown>)
+    if (keys.length !== 1) return false
+    const value = (item as Record<string, unknown>)[keys[0]]
+    return value === null || typeof value === 'string'
+  }
+  return false
+}
+
 function createDefaultMdsiteConfig(siteName: string): MdsiteConfig {
   return {
-    favicon: '',
     features: {
       bibleTooltips: true,
-      sourceEdit: true
+      sourceEdit: '',
+      footer: []
     },
     menu: [],
-    footer: [],
-    server: {
-      output: '.output',
-      path: '.mdsite',
-      repo: 'https://github.com/life-and-dev/mdsite',
-      gitBranch: 'main'
+    paths: {
+      input: '',
+      build: '.mdsite',
+      output: '.output'
     },
     site: {
       canonical: '',
+      favicon: '',
       name: siteName
     },
     themes: {
@@ -251,27 +296,27 @@ function createDefaultMdsiteConfig(siteName: string): MdsiteConfig {
 
 function normalizeMdsiteConfig(rawConfig: Record<string, any>, contentDir: string): MdsiteConfig {
   const fallbackConfig = createDefaultMdsiteConfig(path.basename(contentDir) || 'Site');
-  const contentPath = resolveContentConfigPath(rawConfig.content);
+  const inputPath = resolveInputConfigPath(rawConfig.paths?.input);
 
   return {
-    favicon: typeof rawConfig.favicon === 'string' ? rawConfig.favicon : fallbackConfig.favicon,
     features: {
-      bibleTooltips: rawConfig.features?.bibleTooltips ?? fallbackConfig.features.bibleTooltips,
-      sourceEdit: rawConfig.features?.sourceEdit ?? fallbackConfig.features.sourceEdit
+      bibleTooltips: rawConfig.features?.['bible-tooltips'] ?? fallbackConfig.features.bibleTooltips,
+      sourceEdit: typeof rawConfig.features?.['source-edit'] === 'string'
+        ? rawConfig.features['source-edit']
+        : fallbackConfig.features.sourceEdit,
+      footer: Array.isArray(rawConfig.features?.footer)
+        ? rawConfig.features.footer.filter(isValidFooterItem)
+        : fallbackConfig.features.footer
     },
-    content: contentPath ? { path: contentPath } : fallbackConfig.content,
     menu: Array.isArray(rawConfig.menu) ? rawConfig.menu : fallbackConfig.menu,
-    footer: Array.isArray(rawConfig.footer) ? rawConfig.footer.filter((item): item is string => typeof item === 'string') : [],
-    server: {
-      output: typeof rawConfig.server?.output === 'string' ? rawConfig.server.output : fallbackConfig.server.output,
-      path: typeof rawConfig.server?.path === 'string' ? rawConfig.server.path : fallbackConfig.server.path,
-      repo: typeof rawConfig.server?.repo === 'string' ? rawConfig.server.repo : fallbackConfig.server.repo,
-      gitBranch: typeof rawConfig.server?.['git-branch'] === 'string' && rawConfig.server['git-branch'].trim()
-        ? rawConfig.server['git-branch']
-        : fallbackConfig.server.gitBranch
+    paths: {
+      input: inputPath ?? fallbackConfig.paths.input,
+      build: typeof rawConfig.paths?.build === 'string' ? rawConfig.paths.build : fallbackConfig.paths.build,
+      output: typeof rawConfig.paths?.output === 'string' ? rawConfig.paths.output : fallbackConfig.paths.output
     },
     site: {
       canonical: typeof rawConfig.site?.canonical === 'string' ? rawConfig.site.canonical : fallbackConfig.site.canonical,
+      favicon: typeof rawConfig.site?.favicon === 'string' ? rawConfig.site.favicon : fallbackConfig.site.favicon,
       name: typeof rawConfig.site?.name === 'string' && rawConfig.site.name.trim() ? rawConfig.site.name : fallbackConfig.site.name
     },
     themes: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@life-and-dev/mdsite",
-  "version": "0.6.0",
+  "version": "0.7.0",
   "type": "module",
   "private": false,
   "description": "Local-first CLI that orchestrates mdsite-nuxt",

package/mdsite-nuxt/example.config.yml

@@ -1,67 +0,0 @@
-content:
-  git:
-    branch: main
-    path: ../example # Path where git content is cloned/checked out relative to this file
-    repo: https://github.com/life-and-dev/md-site # If missing, assume content is part of this git repo
-  path: ../example/docs # Path where md files are located relative to this file
-features:
-  bibleTooltips: true
-  sourceEdit: false
-site:
-  canonical: 'https://life-and-dev.github.io/mdsite/'
-  name: 'Example Site'
-themes:
-  light:
-    colors:
-      primary: '#802020'
-      secondary: '#ffffff'
-      selected: '#802020'
-      error: '#d64d5b'
-      warning: '#c29e4a'
-      info: '#548af7'
-      success: '#6aab73'
-      background: '#f9f9f9'
-      surface: '#ffffff'
-      surface-rail: '#f5f5f5'
-      surface-appbar: '#f0f0f0'
-      on-surface-rail: '#2a2a2a'
-      on-surface-appbar: '#000000'
-      on-background: '#292929'
-      on-surface: '#292929'
-      on-primary: '#ffffff'
-      on-secondary: '#ffffff'
-      on-selectable: '#292929'
-      on-selected: '#ffffff'
-      on-error: '#ffffff'
-      on-warning: '#ffffff'
-      on-info: '#ffffff'
-      on-success: '#ffffff'
-      outline: '#d7d7d7'
-      outline-bars: '#f4f4f4'
-  dark:
-    colors:
-      primary: '#af5f5f'
-      secondary: '#302d2b'
-      selected: '#af5f5f'
-      error: '#d64d5b'
-      warning: '#c29e4a'
-      info: '#548af7'
-      success: '#6aab73'
-      background: '#161616'
-      surface: '#0d0d0d'
-      surface-rail: '#252525'
-      surface-appbar: '#282828'
-      on-surface-rail: '#d0d0d0'
-      on-surface-appbar: '#ffffff'
-      on-background: '#d1d1d1'
-      on-surface: '#d1d1d1'
-      on-primary: '#111111'
-      on-secondary: '#111111'
-      on-selectable: '#d1d1d1'
-      on-selected: '#ffffff'
-      on-error: '#ffffff'
-      on-warning: '#ffffff'
-      on-info: '#ffffff'
-      on-success: '#ffffff'
-      outline: '#303030'
-      outline-bars: '#161616'