undocs 0.2.0 → 0.2.2

package/bin/cli.mjs

@@ -1,4 +1,4 @@
-#!/usr/bin/env bun
+#!/usr/bin/env node
 import jiti from 'jiti'
 
 jiti(import.meta.url, { esmResolve: true })('../layers/unjs/cli/main.ts')

package/layers/core/app/nuxt.config.ts

@@ -21,6 +21,7 @@ export default defineNuxtConfig({
     '@nuxtjs/seo',
     isProd && '@nuxtjs/plausible',
     '@nuxt/ui',
+    'nuxt-build-cache',
   ],
   ui: {
     icons: [],

package/layers/core/app/server/plugins/content.ts

@@ -1,26 +1,37 @@
 export default defineNitroPlugin((nitroApp) => {
   nitroApp.hooks.hook('content:file:afterParse', (file) => {
-    if (file._id.endsWith('.md')) {
-      // Remove first h1 and p from markdown files as they are added to front-matter by default
-      if (file.body?.children?.[0]?.tag === 'h1' && file.title === file.body.children[0].children?.[0]?.value) {
-        file.body.children.shift()
-      }
-      if (file.body?.children?.[0]?.tag === 'p' && file.description === file.body.children[0].children?.[0]?.value) {
-        file.body.children.shift()
-      }
-      // Handle GitHub flavoured markdown blockquotes
-      // https://github.com/orgs/community/discussions/16925
-      for (const node of file.body?.children || []) {
-        if (
-          node.tag === 'blockquote' && // bloquote > p x 2 > span > text
-          ['!NOTE', '!TIP', '!IMPORTANT', '!WARNING', '!CAUTION'].includes(
-            node.children?.[0]?.children?.[0]?.children?.[0]?.value,
-          )
-        ) {
-          node.type = 'element'
-          node.tag = node.children?.[0]?.children?.[0]?.children?.[0]?.value.slice(1).toLowerCase()
-          node.children[0].children.shift()
-        }
+    // Filter out non-markdown files
+    if (!file._id.endsWith('.md')) {
+      return
+    }
+
+    // Remove first h1 from markdown files as it is added to front-matter as title
+    if (file.body?.children?.[0]?.tag === 'h1' && file.title === file.body.children[0].children?.[0]?.value) {
+      file.body.children.shift()
+    }
+
+    // Only use the first blockquote as the description
+    const firstChild = file.body.children?.[0]
+    const firstChildContent = firstChild?.children?.[0]?.children?.[0]?.value
+    if (firstChild.tag === 'blockquote' && firstChildContent) {
+      file.description = firstChildContent
+      file.body.children.shift()
+    } else {
+      file.description = '' // Avoid duplication
+    }
+
+    // Handle GitHub flavoured markdown blockquotes
+    // https://github.com/orgs/community/discussions/16925
+    for (const node of file.body?.children || []) {
+      if (
+        node.tag === 'blockquote' && // bloquote > p x 2 > span > text
+        ['!NOTE', '!TIP', '!IMPORTANT', '!WARNING', '!CAUTION'].includes(
+          node.children?.[0]?.children?.[0]?.children?.[0]?.value,
+        )
+      ) {
+        node.type = 'element'
+        node.tag = node.children?.[0]?.children?.[0]?.children?.[0]?.value.slice(1).toLowerCase()
+        node.children[0].children.shift()
       }
     }
   })

package/layers/core/cli/cli.ts

@@ -25,7 +25,7 @@ export function createCLI(opts: DocsCLIOptions = {}) {
     },
     args: { ...sharedArgs },
     async setup({ args }) {
-      const { appDir, nuxtConfig } = await setupDocs(args.dir, opts.setup)
+      const { appDir, nuxtConfig } = await setupDocs(args.dir, { ...opts.setup, dev: true })
       process.chdir(appDir)
       await import('nuxi').then((nuxi) =>
         nuxi.runCommand('dev', [appDir, '--no-fork', '--port', '4000'], { overrides: nuxtConfig }),

package/layers/core/cli/setup.ts

@@ -10,6 +10,7 @@ const pkgDir = fileURLToPath(new URL('../../..', import.meta.url))
 
 export interface SetupDocsOptions {
   defaults?: DocsConfig
+  dev?: boolean
   extends?: string[]
 }
 
@@ -21,7 +22,7 @@ export async function setupDocs(docsDir: string, opts: SetupDocsOptions = {}) {
   docsconfig.dir = docsDir = resolve(docsconfig.dir || docsDir)
 
   // URL is required for production build (SEO)
-  if (!docsconfig.url) {
+  if (!docsconfig.url && !opts.dev) {
     throw new Error('`url` config is required for production build!')
   }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "undocs",
-  "version": "0.2.0",
+  "version": "0.2.2",
   "repository": "unjs/undocs",
   "license": "MIT",
   "type": "module",
@@ -27,24 +27,25 @@
     "undocs": "./bin/cli.mjs"
   },
   "dependencies": {
-    "@nuxt/content": "^2.11.0",
+    "@nuxt/content": "^2.12.0",
     "@nuxt/ui": "^2.13.0",
     "@nuxt/ui-pro": "^0.7.5",
     "@nuxthq/studio": "^1.0.10",
     "@nuxtjs/fontaine": "^0.4.1",
     "@nuxtjs/google-fonts": "^3.1.3",
     "@nuxtjs/plausible": "^0.2.4",
-    "@nuxtjs/seo": "^2.0.0-rc.7",
-    "@nuxtjs/tailwindcss": "^6.11.2",
-    "c12": "^1.6.1",
+    "@nuxtjs/seo": "^2.0.0-rc.8",
+    "@nuxtjs/tailwindcss": "^6.11.3",
+    "c12": "^1.7.0",
     "citty": "^0.1.5",
     "consola": "^3.2.3",
     "defu": "^6.1.4",
     "is-buffer": "^2.0.5",
     "nuxi": "^3.10.0",
-    "nuxt": "^3.10.0",
+    "nuxt": "^3.10.1",
+    "nuxt-build-cache": "^0.1.1",
     "pkg-types": "^1.0.3",
-    "scule": "^1.2.0",
+    "scule": "^1.3.0",
     "tailwindcss": "^3.4.1",
     "theme-colors": "^0.1.0",
     "unstorage": "^1.10.1",
@@ -58,9 +59,9 @@
     "eslint": "^8.56.0",
     "eslint-config-unjs": "^0.2.1",
     "jiti": "^1.21.0",
-    "prettier": "^3.2.4",
+    "prettier": "^3.2.5",
     "typescript": "^5.3.3",
     "vue-tsc": "^1.8.27"
   },
-  "packageManager": "bun@1.0.25"
-}
+  "packageManager": "bun@1.0.26"
+}