@life-and-dev/mdsite 0.6.0 → 0.7.1

package/mdsite-nuxt/nuxt.config.ts

@@ -9,17 +9,17 @@ import { loadMdsiteConfigSync } from './utils/mdsite-config'
 const mdsite = loadMdsiteConfigSync()
 const siteConfig = mdsite.config
 const appBaseURL = process.env.NUXT_APP_BASE_URL || '/'
-// The git repo root, used by `useSourceEdit` to compute the
-// repo-relative path to a content file (so the Edit-on-GitHub URL
-// points at `…/blob/<branch>/<subdir>/<file>.md` rather than a
-// cwd-relative or absolute filesystem path). We default to the
-// directory containing `mdsite.yml` because that is the conventional
-// git root for an mdsite content dir; falling back to the content
-// dir itself covers the case where `mdsite.yml` is missing (legacy
-// `content.config.yml` layouts loaded through `renderer-hooks`).
-const contentGitPath = mdsite.configPath
-  ? path.dirname(mdsite.configPath)
-  : mdsite.contentDir
+
+// mdsite is a static site generator. SSR is only needed at build time so
+// `nuxi generate` can pre-render every route to HTML. In `dev` and
+// `preview` mode SSR uses a per-request fork worker that pulls the full
+// Nuxt + Vuetify + @nuxt/content + mermaid + sharp pipeline and OOMs
+// (Worker terminated … JS heap out of memory) on memory-constrained
+// hosts. Keep SSR on for build/generate, off for dev/preview so the
+// dev server renders client-side only and `mdsite generate` still
+// produces per-route static HTML.
+const isSsrNuxtCommand = process.argv.includes('build') || process.argv.includes('generate')
+const ssrEnabled = isSsrNuxtCommand
 
 export default defineNuxtConfig({
   compatibilityDate: '2025-07-15',
@@ -29,7 +29,6 @@ export default defineNuxtConfig({
     public: {
       contentDomain: path.basename(mdsite.contentDir),
       contentPath: mdsite.contentDir,
-      contentGitPath,
       // `mdsite.config` is a valid `MdsiteConfig` at runtime, but
       // Nuxt's runtime-config type generator collapses every complex
       // field of `siteConfig` to a degenerate shape — `menu` becomes
@@ -58,10 +57,18 @@ export default defineNuxtConfig({
   },
 
   nitro: {
-    preset: 'static'  // Pure static preset - no SPA fallbacks
+    preset: 'static',  // Pure static preset - no SPA fallbacks
+    // The `mdsite` CLI sets `MDSITE_NITRO_OUTPUT_DIR` in dev mode so the
+    // build output lands in the content directory's `<paths.build>/.output/`
+    // rather than inside the renderer source (e.g. the `mdsite-nuxt/`
+    // submodule). The default `.output` is kept for direct use of the
+    // renderer (e.g. running `nuxt generate` by hand for renderer dev).
+    output: {
+      dir: process.env.MDSITE_NITRO_OUTPUT_DIR || '.output'
+    }
   },
 
-  ssr: true,
+  ssr: ssrEnabled,
 
   css: [
     '~/assets/css/markdown.css',

package/mdsite-nuxt/scripts/generate-favicons.test.ts

@@ -66,12 +66,12 @@ describe('generate-favicons', () => {
   })
 
   describe('generateFavicons', () => {
-    it('uses the bundled default favicon and writes all expected assets when config.favicon is empty', async () => {
+    it('uses the bundled default favicon and writes all expected assets when site.favicon is empty', async () => {
       const outputDir = path.join(tmpDir, 'output')
 
       const ok = await generateFavicons({
         contentDir: tmpDir,
-        config: { favicon: '' },
+        config: { site: { favicon: '' } },
         outputDir,
       })
 
@@ -106,7 +106,7 @@ describe('generate-favicons', () => {
 
       const ok = await generateFavicons({
         contentDir: tmpDir,
-        config: { favicon: 'favicon.svg' },
+        config: { site: { favicon: 'favicon.svg' } },
         outputDir,
       })
 

package/mdsite-nuxt/scripts/generate-favicons.ts

@@ -38,7 +38,7 @@ export function resolveFaviconSource(
 
 export interface GenerateFaviconsOptions {
   contentDir?: string
-  config?: { favicon?: string; site?: { name?: string } }
+  config?: { site?: { favicon?: string; name?: string } }
   outputDir?: string
 }
 
@@ -50,9 +50,9 @@ export async function generateFavicons(options: GenerateFaviconsOptions = {}): P
     ? { contentDir: options.contentDir, config: options.config }
     : loadMdsiteConfigSync()
   const { contentDir, config } = resolved
-  const siteName = (config as { site?: { name?: string } }).site?.name ?? 'site'
+  const siteName = config.site?.name ?? 'site'
 
-  const resolvedSource = resolveFaviconSource(contentDir, config.favicon ?? '')
+  const resolvedSource = resolveFaviconSource(contentDir, config.site?.favicon ?? '')
 
   if (!resolvedSource) {
     console.error('❌ No favicon source available (configured source missing AND bundled default not found).')
@@ -64,7 +64,7 @@ export async function generateFavicons(options: GenerateFaviconsOptions = {}): P
   await fs.ensureDir(publicDir)
 
   if (resolvedSource.isDefault) {
-    console.log('ℹ️ No favicon source configured (config.favicon empty or file not found). Using bundled default favicon.')
+    console.log('ℹ️ No favicon source configured (site.favicon empty or file not found). Using bundled default favicon.')
   }
 
   console.log(`🎨 Generating favicons for site: ${siteName}`)

package/mdsite-nuxt/scripts/generate-indices.test.ts

@@ -2,7 +2,7 @@ import fs from 'node:fs/promises'
 import os from 'node:os'
 import path from 'node:path'
 
-import { afterEach, beforeEach, describe, expect, it } from 'vitest'
+import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest'
 
 import { generateNavigationJson, generateSearchIndexJson, generateFooterJson } from './generate-indices.js'
 
@@ -244,7 +244,7 @@ describe('generated content indices', () => {
       return JSON.parse(await fs.readFile(path.join(publicDir, '_navigation.json'), 'utf8'))
     }
 
-    it('generates _footer.json with paths and titles from mdsite.yml footer section', async () => {
+    it('generates _footer.json with paths and titles from mdsite.yml features.footer section', async () => {
       await fs.writeFile(path.join(contentDir, 'index.md'), '# Home\n\nWelcome home.', 'utf8')
       await fs.writeFile(path.join(contentDir, 'about.md'), '# About\n\nAbout us.', 'utf8')
       await fs.writeFile(path.join(contentDir, 'contacts.md'), '# Contacts\n\nContact us.', 'utf8')
@@ -253,9 +253,37 @@ describe('generated content indices', () => {
       await fs.writeFile(mdsitePath, [
         'site:',
         '  name: Test Site',
-        'footer:',
-        '  - about',
-        '  - contacts',
+        'features:',
+        '  footer:',
+        '    - about',
+        '    - contacts',
+        '',
+      ].join('\n'), 'utf8')
+      process.env.MDSITE_CONFIG_PATH = mdsitePath
+
+      await generateFooterJson()
+
+      const footer = await readFooter()
+      expect(footer).toEqual([
+        { path: '/about', title: 'About', type: 'link', isExternal: false },
+        { path: '/contacts', title: 'Contacts', type: 'link', isExternal: false },
+      ])
+    })
+
+    it('generates _footer.json with custom labels, external URLs, and separators', async () => {
+      await fs.writeFile(path.join(contentDir, 'index.md'), '# Home', 'utf8')
+      await fs.writeFile(path.join(contentDir, 'about.md'), '# About', 'utf8')
+
+      const mdsitePath = path.join(tempDir, 'mdsite.yml')
+      await fs.writeFile(mdsitePath, [
+        'site:',
+        '  name: Test Site',
+        'features:',
+        '  footer:',
+        '    - about',
+        '    - "About Page": about',
+        '    - "GitHub Repo": https://github.com/life-and-dev/mdsite',
+        '    - null',
         '',
       ].join('\n'), 'utf8')
       process.env.MDSITE_CONFIG_PATH = mdsitePath
@@ -264,8 +292,10 @@ describe('generated content indices', () => {
 
       const footer = await readFooter()
       expect(footer).toEqual([
-        { path: '/about', title: 'About' },
-        { path: '/contacts', title: 'Contacts' },
+        { path: '/about', title: 'About', type: 'link', isExternal: false },
+        { path: '/about', title: 'About Page', type: 'link', isExternal: false },
+        { path: 'https://github.com/life-and-dev/mdsite', title: 'GitHub Repo', type: 'link', isExternal: true },
+        { path: '', title: '', type: 'separator', isExternal: false },
       ])
     })
 
@@ -297,8 +327,9 @@ describe('generated content indices', () => {
         'menu:',
         '  - index',
         '  - guide',
-        'footer:',
-        '  - contacts',
+        'features:',
+        '  footer:',
+        '    - contacts',
         '',
       ].join('\n'), 'utf8')
       process.env.MDSITE_CONFIG_PATH = mdsitePath
@@ -314,10 +345,39 @@ describe('generated content indices', () => {
 
       const footer = await readFooter()
       expect(footer).toEqual([
-        { path: '/contacts', title: 'Contacts' },
+        { path: '/contacts', title: 'Contacts', type: 'link', isExternal: false },
       ])
     })
 
+    it('excludes custom-labelled internal footer entries from the navigation tree', async () => {
+      await fs.writeFile(path.join(contentDir, 'index.md'), '# Home', 'utf8')
+      await fs.writeFile(path.join(contentDir, 'guide.md'), '# Guide', 'utf8')
+      await fs.writeFile(path.join(contentDir, 'about.md'), '# About', 'utf8')
+
+      const mdsitePath = path.join(tempDir, 'mdsite.yml')
+      await fs.writeFile(mdsitePath, [
+        'site:',
+        '  name: Test Site',
+        'menu:',
+        '  - index',
+        '  - guide',
+        'features:',
+        '  footer:',
+        '    - "About Page": about',
+        '',
+      ].join('\n'), 'utf8')
+      process.env.MDSITE_CONFIG_PATH = mdsitePath
+
+      await generateNavigationJson()
+      await generateFooterJson()
+
+      const navigation = await readNavigation()
+      const paths = navigation.map((n: { path: string }) => n.path)
+      expect(paths).toContain('/')
+      expect(paths).toContain('/guide')
+      expect(paths).not.toContain('/about')
+    })
+
     it('excludes footer entries from the fallback navigation tree', async () => {
       await fs.writeFile(path.join(contentDir, 'index.md'), '# Home\n\nWelcome home.', 'utf8')
       await fs.writeFile(path.join(contentDir, 'about.md'), '# About\n\nAbout us.', 'utf8')
@@ -327,7 +387,8 @@ describe('generated content indices', () => {
       await fs.writeFile(mdsitePath, [
         'site:',
         '  name: Test Site',
-        'footer: [contacts]',
+        'features:',
+        '  footer: [contacts]',
         '',
       ].join('\n'), 'utf8')
       delete process.env.MDSITE_CONFIG_PATH
@@ -341,4 +402,153 @@ describe('generated content indices', () => {
       expect(paths).not.toContain('/contacts')
     })
   })
+
+  describe('build/dependency directory exclusion', () => {
+    async function readSearchIndex() {
+      return JSON.parse(await fs.readFile(path.join(publicDir, '_search-index.json'), 'utf8'))
+    }
+
+    async function readNavigation() {
+      return JSON.parse(await fs.readFile(path.join(publicDir, '_navigation.json'), 'utf8'))
+    }
+
+    /**
+     * Build a fake content tree that mimics a project root used as the
+     * content directory: real user pages alongside build artifacts, hidden
+     * editor dirs, and a top-level `node_modules`/`dist`. Returns the set
+     * of "expected to be indexed" markdown paths.
+     */
+    async function plantMixedTree() {
+      // User-authored content at the content root
+      await fs.writeFile(path.join(contentDir, 'index.md'), '# Home\n\nWelcome home.', 'utf8')
+      await fs.writeFile(path.join(contentDir, 'guide.md'), '# Guide\n\nUseful guide.', 'utf8')
+      await fs.mkdir(path.join(contentDir, 'features'), { recursive: true })
+      await fs.writeFile(path.join(contentDir, 'features', 'theme.md'), '# Theme\n\nContent.', 'utf8')
+
+      // Renderer working dir with nested node_modules containing a README
+      // — mimics the layout the CLI materializes on first run.
+      await fs.mkdir(path.join(contentDir, '.mdsite', 'node_modules', 'some-pkg'), { recursive: true })
+      await fs.writeFile(
+        path.join(contentDir, '.mdsite', 'node_modules', 'some-pkg', 'README.md'),
+        '# some-pkg\n\nThis is a dependency README and should be ignored.'
+      )
+
+      // A top-level node_modules dir (e.g. when the content root IS the
+      // project root) should also be skipped.
+      await fs.mkdir(path.join(contentDir, 'node_modules', 'transitive'), { recursive: true })
+      await fs.writeFile(
+        path.join(contentDir, 'node_modules', 'transitive', 'README.md'),
+        '# transitive\n\nShould also be ignored.'
+      )
+
+      // A `dist` directory (top-level build output) should also be skipped.
+      await fs.mkdir(path.join(contentDir, 'dist', 'legacy'), { recursive: true })
+      await fs.writeFile(
+        path.join(contentDir, 'dist', 'legacy', 'stale.md'),
+        '# Stale\n\nShould be ignored.'
+      )
+
+      // Any hidden directory at any depth should be skipped — editor state,
+      // tooling caches, etc. `.vscode`, `.idea`, `.history`, `.cache` are
+      // all common offenders when the content root is the project root.
+      for (const hidden of ['.vscode', '.idea', '.history', '.cache']) {
+        await fs.mkdir(path.join(contentDir, hidden, 'notes'), { recursive: true })
+        await fs.writeFile(
+          path.join(contentDir, hidden, 'notes', 'scratch.md'),
+          `# ${hidden}\n\nShould be ignored.`
+        )
+      }
+
+      // Nuxt/Nitro/CMS output dirs that may sit next to the content.
+      for (const hidden of ['.nuxt', '.output', '.nitro', '.data', '.git']) {
+        await fs.mkdir(path.join(contentDir, hidden), { recursive: true })
+        await fs.writeFile(
+          path.join(contentDir, hidden, 'scratch.md'),
+          `# ${hidden}\n\nShould be ignored.`
+        )
+      }
+    }
+
+    it('does not index .md files under any hidden directory, node_modules, or dist', async () => {
+      await plantMixedTree()
+
+      // console.warn would log a "No H1 found" notice for any file the
+      // walker still visited — silence it so the test output stays clean.
+      const warnSpy = vi.spyOn(console, 'warn').mockImplementation(() => {})
+
+      try {
+        await generateSearchIndexJson()
+      } finally {
+        warnSpy.mockRestore()
+      }
+
+      const searchIndex = await readSearchIndex()
+      const paths = searchIndex.map((entry: { path: string }) => entry.path)
+      // User-authored pages are still indexed
+      expect(paths).toContain('/')
+      expect(paths).toContain('/guide')
+      expect(paths).toContain('/features/theme')
+      // No entry leaks from a build/dependency or hidden directory
+      for (const excluded of [
+        '.mdsite',
+        'node_modules',
+        'dist',
+        '.nuxt',
+        '.output',
+        '.nitro',
+        '.data',
+        '.git',
+        '.vscode',
+        '.idea',
+        '.history',
+        '.cache'
+      ]) {
+        expect(paths.some((p: string) => p.split('/').includes(excluded))).toBe(false)
+      }
+      const noH1Warnings = warnSpy.mock.calls
+        .map((call) => String(call[0] ?? ''))
+        .filter((line) => line.startsWith('⚠️'))
+      expect(noH1Warnings).toEqual([])
+    })
+
+    it('excludes build/dependency and hidden directories from the fallback navigation tree', async () => {
+      await plantMixedTree()
+
+      const warnSpy = vi.spyOn(console, 'warn').mockImplementation(() => {})
+
+      try {
+        await generateNavigationJson()
+      } finally {
+        warnSpy.mockRestore()
+      }
+
+      const navigation = await readNavigation()
+      const paths = navigation.map((n: { path: string }) => n.path)
+      expect(paths).toContain('/')
+      expect(paths).toContain('/guide')
+      expect(paths).toContain('/features/theme')
+      // No node should be derived from a build/dependency or hidden directory
+      for (const excluded of [
+        '.mdsite',
+        'node_modules',
+        'dist',
+        '.nuxt',
+        '.output',
+        '.nitro',
+        '.data',
+        '.git',
+        '.vscode',
+        '.idea',
+        '.history',
+        '.cache'
+      ]) {
+        expect(paths.some((p: string) => p.split('/').includes(excluded))).toBe(false)
+      }
+
+      const noH1Warnings = warnSpy.mock.calls
+        .map((call) => String(call[0] ?? ''))
+        .filter((line) => line.startsWith('⚠️'))
+      expect(noH1Warnings).toEqual([])
+    })
+  })
 })