@movk/nuxt-docs 1.1.0

package/modules/component-meta.ts

@@ -0,0 +1,22 @@
+import { defineNuxtModule } from '@nuxt/kit'
+import type { NuxtComponentMeta } from 'nuxt-component-meta'
+
+export default defineNuxtModule({
+  meta: {
+    name: 'component-meta'
+  },
+  async setup(_options, nuxt) {
+    // @ts-expect-error - Hook is not typed correctly
+    nuxt.hook('component-meta:schema', (schema: NuxtComponentMeta) => {
+      for (const componentName in schema) {
+        const component = schema[componentName]
+        // Delete schema from slots to reduce metadata file size
+        if (component?.meta?.slots) {
+          for (const slot of component.meta.slots) {
+            delete (slot as any).schema
+          }
+        }
+      }
+    })
+  }
+})

package/modules/config.ts

@@ -0,0 +1,79 @@
+import { createResolver, defineNuxtModule } from '@nuxt/kit'
+import { defu } from 'defu'
+import { getGitBranch, getGitEnv, getLocalGitInfo } from '../utils/git'
+import { getPackageJsonMetadata, inferSiteURL } from '../utils/meta'
+
+export default defineNuxtModule({
+  meta: {
+    name: 'config'
+  },
+  async setup(_options, nuxt) {
+    const { resolve } = createResolver(import.meta.url)
+    const dir = nuxt.options.rootDir
+    const url = inferSiteURL()
+    const meta = await getPackageJsonMetadata(dir)
+    const gitInfo = await getLocalGitInfo(dir) || getGitEnv()
+    const siteName = nuxt.options?.site?.name || meta.name || gitInfo?.name || ''
+
+    nuxt.options.llms = defu(nuxt.options.llms, {
+      domain: url || 'https://example.com',
+      title: siteName,
+      description: meta.description || '',
+      full: {
+        title: siteName,
+        description: meta.description || ''
+      }
+    })
+
+    nuxt.options.site = defu(nuxt.options.site, {
+      url,
+      name: siteName,
+      debug: false
+    })
+
+    nuxt.options.robots = defu(nuxt.options.robots, {
+      sitemap: url ? `${url.replace(/\/$/, '')}/sitemap.xml` : undefined
+    })
+
+    nuxt.options.appConfig.header = defu(nuxt.options.appConfig.header, {
+      title: siteName
+    })
+
+    nuxt.options.appConfig.seo = defu(nuxt.options.appConfig.seo, {
+      titleTemplate: `%s - ${siteName}`,
+      title: siteName,
+      description: meta.description || ''
+    })
+
+    nuxt.options.appConfig.github = defu(nuxt.options.appConfig.github, {
+      owner: gitInfo?.owner,
+      name: gitInfo?.name,
+      url: gitInfo?.url,
+      branch: getGitBranch()
+    })
+
+    const componentsPath = resolve('../app/components')
+
+    nuxt.options.componentMeta = defu(nuxt.options.componentMeta, {
+      exclude: [
+        '@nuxt/content',
+        '@nuxt/icon',
+        '@nuxt/image',
+        '@nuxtjs/color-mode',
+        '@nuxtjs/mdc',
+        'nuxt/dist',
+        'nuxt-og-image',
+        '@nuxtjs/plausible',
+        '@nuxt/ui',
+        new RegExp(`${componentsPath.replace(/[/\\]/g, '[/\\\\]')}/(?!content/(ComponentEmits|ComponentProps|ComponentSlots|ComponentExample)\\.vue$)`)
+      ],
+      metaFields: {
+        type: false,
+        props: true,
+        slots: true,
+        events: true,
+        exposed: false
+      }
+    })
+  }
+})

package/modules/css.ts

@@ -0,0 +1,33 @@
+import { addTemplate, createResolver, defineNuxtModule } from '@nuxt/kit'
+import { joinURL } from 'ufo'
+import { resolveModulePath } from 'exsolve'
+
+export default defineNuxtModule({
+  meta: {
+    name: 'css'
+  },
+  async setup(_options, nuxt) {
+    const dir = nuxt.options.rootDir
+    const { resolve } = createResolver(import.meta.url)
+
+    const layerDir = resolve('../app')
+    const contentDir = joinURL(dir, 'content')
+    const uiPath = resolveModulePath('@nuxt/ui', { from: import.meta.url, conditions: ['style'] })
+    const tailwindPath = resolveModulePath('tailwindcss', { from: import.meta.url, conditions: ['style'] })
+
+    const cssTemplate = addTemplate({
+      filename: 'movk-nuxt-docs.css',
+      getContents: () => {
+        return `@import ${JSON.stringify(tailwindPath)};
+@import ${JSON.stringify(tailwindPath)}/theme.css theme(static);
+@import ${JSON.stringify(uiPath)};
+
+@source "${contentDir.replace(/\\/g, '/')}/**/*";
+@source "${layerDir.replace(/\\/g, '/')}/**/*";
+@source "../../app.config.ts";`
+      }
+    })
+
+    nuxt.options.css.unshift(cssTemplate.dst)
+  }
+})

package/nuxt.config.ts

@@ -0,0 +1,80 @@
+import { createResolver } from '@nuxt/kit'
+
+const { resolve } = createResolver(import.meta.url)
+
+export default defineNuxtConfig({
+  modules: [
+    resolve('./modules/config'),
+    resolve('./modules/css'),
+    resolve('./modules/component-example'),
+    resolve('./modules/component-meta'),
+    '@nuxt/ui',
+    '@nuxt/content',
+    '@nuxt/image',
+    '@vueuse/nuxt',
+    '@nuxtjs/seo',
+    'nuxt-component-meta',
+    'motion-v/nuxt',
+    'nuxt-llms'
+  ],
+  content: {
+    build: {
+      markdown: {
+        highlight: {
+          langs: ['bash', 'ts', 'typescript', 'diff', 'vue', 'json', 'yml', 'css', 'mdc', 'blade', 'edge']
+        }
+      }
+    }
+  },
+  mdc: {
+    highlight: {
+      noApiRoute: false
+    }
+  },
+  compatibilityDate: 'latest',
+  nitro: {
+    prerender: {
+      routes: ['/', '/sitemap.xml', '/robots.txt', '/404.html'],
+      crawlLinks: true,
+      autoSubfolderIndex: false
+    }
+  },
+  vite: {
+    optimizeDeps: {
+      include: [
+        '@nuxt/content > slugify',
+        'colortranslator',
+        'tailwindcss/colors',
+        'tailwind-variants',
+        'ufo',
+        'zod',
+        'scule',
+        'motion-v',
+        'ohash'
+      ]
+    }
+  },
+  icon: {
+    provider: 'iconify'
+  },
+  linkChecker: {
+    report: {
+      publish: true,
+      html: true,
+      markdown: true,
+      json: true
+    }
+  },
+  ogImage: {
+    googleFontMirror: 'fonts.loli.net',
+    fonts: [
+      // 思源黑体 - 支持中文
+      'Noto+Sans+SC:400',
+      'Noto+Sans+SC:500',
+      'Noto+Sans+SC:700',
+      // 如果需要英文字体
+      'Inter:400',
+      'Inter:700'
+    ]
+  }
+})

package/package.json

@@ -0,0 +1,55 @@
+{
+  "name": "@movk/nuxt-docs",
+  "type": "module",
+  "version": "1.1.0",
+  "private": false,
+  "description": "An elegant documentation theme for Nuxt, powered by Nuxt UI and Nuxt Content.",
+  "author": "YiXuan <mhaibaraai@gmail.com>",
+  "license": "MIT",
+  "homepage": "https://docs.mhaibaraai.cn",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/mhaibaraai/movk-nuxt-docs.git"
+  },
+  "main": "./nuxt.config.ts",
+  "peerDependencies": {
+    "better-sqlite3": "12.x",
+    "nuxt": "4.x"
+  },
+  "files": [
+    "app",
+    "content.config.ts",
+    "modules",
+    "nuxt.config.ts",
+    "server",
+    "utils",
+    "pnpm-workspace.yaml",
+    "README.md"
+  ],
+  "dependencies": {
+    "@iconify-json/lucide": "^1.2.69",
+    "@iconify-json/simple-icons": "^1.2.54",
+    "@iconify-json/vscode-icons": "^1.2.32",
+    "@movk/core": "^0.0.5",
+    "@nuxt/content": "^3.7.1",
+    "@nuxt/image": "^1.11.0",
+    "@nuxt/kit": "^4.1.3",
+    "@nuxt/ui": "^4.0.1",
+    "@nuxtjs/seo": "^3.2.2",
+    "@vueuse/core": "^13.9.0",
+    "@vueuse/nuxt": "^13.9.0",
+    "defu": "^6.1.4",
+    "pathe": "^2.0.3",
+    "exsolve": "^1.0.7",
+    "git-url-parse": "^16.1.0",
+    "motion-v": "^1.7.2",
+    "nuxt-component-meta": "^0.14.1",
+    "prettier": "^3.6.2",
+    "nuxt-llms": "^0.1.3",
+    "pkg-types": "^2.3.0",
+    "scule": "^1.3.0",
+    "tailwindcss": "^4.1.14",
+    "ohash": "^2.0.11",
+    "ufo": "^1.6.1"
+  }
+}

package/server/api/component-example.get.ts

@@ -0,0 +1,19 @@
+import { defineEventHandler, createError, appendHeader } from 'h3'
+import { pascalCase } from 'scule'
+// @ts-expect-error - no types available
+import components from '#component-example/nitro'
+
+export default defineEventHandler((event) => {
+  appendHeader(event, 'Access-Control-Allow-Origin', '*')
+  const componentName = (event.context.params?.['component?'] || '').replace(/\.json$/, '')
+  if (componentName) {
+    const component = components[pascalCase(componentName)]
+    if (!component) {
+      throw createError({
+        statusMessage: 'Example not found!',
+        statusCode: 404
+      })
+    }
+    return component
+  }
+})

package/server/plugins/llms.ts

@@ -0,0 +1,24 @@
+export default defineNitroPlugin((nitroApp) => {
+  /**
+   * @see
+   * https://github.com/nuxt-content/nuxt-llms?tab=readme-ov-file#readme
+   */
+  nitroApp.hooks.hook('llms:generate', (_, { sections, domain }) => {
+    // Transform links except for "Documentation Sets"
+    sections.forEach((section) => {
+      if (section.title !== 'Documentation Sets') {
+        section.links = section.links?.map(link => ({
+          ...link,
+          href: `${link.href.replace(new RegExp(`^${domain}`), `${domain}/raw`)}.md`
+        }))
+      }
+    })
+
+    // Move "Documentation Sets" to the end
+    const docSetIdx = sections.findIndex(s => s.title === 'Documentation Sets')
+    if (docSetIdx !== -1) {
+      const [docSet] = sections.splice(docSetIdx, 1)
+      sections.push(docSet)
+    }
+  })
+})

package/server/routes/raw/[...slug].md.get.ts

@@ -0,0 +1,27 @@
+import type { Collections } from '@nuxt/content'
+import { queryCollection } from '@nuxt/content/server'
+import { stringify } from 'minimark/stringify'
+import { withLeadingSlash } from 'ufo'
+
+export default eventHandler(async (event) => {
+  const slug = getRouterParams(event)['slug.md']
+  if (!slug?.endsWith('.md')) {
+    throw createError({ statusCode: 404, statusMessage: 'Page not found', fatal: true })
+  }
+
+  const path = withLeadingSlash(slug.replace('.md', ''))
+
+  const page = await queryCollection(event, 'docs' as keyof Collections).path(path).first()
+  if (!page) {
+    throw createError({ statusCode: 404, statusMessage: 'Page not found', fatal: true })
+  }
+
+  // Add title and description to the top of the page if missing
+  if (page.body.value[0]?.[0] !== 'h1') {
+    page.body.value.unshift(['blockquote', {}, page.description])
+    page.body.value.unshift(['h1', {}, page.title])
+  }
+
+  setHeader(event, 'Content-Type', 'text/markdown; charset=utf-8')
+  return stringify({ ...page.body, type: 'minimark' }, { format: 'markdown/html' })
+})

package/utils/git.ts

@@ -0,0 +1,108 @@
+// copy from https://github.com/nuxt-content/docus/tree/main/layer/utils
+import { execSync } from 'node:child_process'
+import gitUrlParse from 'git-url-parse'
+import { readGitConfig } from 'pkg-types'
+
+export interface GitInfo {
+  // Repository name
+  name: string
+  // Repository owner/organization
+  owner: string
+  // Repository URL
+  url: string
+}
+
+export function getGitBranch() {
+  const envName
+    = process.env.CF_PAGES_BRANCH
+      || process.env.CI_COMMIT_BRANCH
+      || process.env.VERCEL_GIT_COMMIT_REF
+      || process.env.BRANCH
+      || process.env.GITHUB_REF_NAME
+
+  if (envName && envName !== 'HEAD') {
+    return envName
+  }
+  try {
+    const branch = execSync('git rev-parse --abbrev-ref HEAD', { stdio: ['ignore', 'pipe', 'ignore'] }).toString().trim()
+    if (branch && branch !== 'HEAD') {
+      return branch
+    }
+  } catch {
+    // Ignore error
+  }
+
+  return 'main'
+}
+
+export async function getLocalGitInfo(rootDir: string): Promise<GitInfo | undefined> {
+  const remote = await getLocalGitRemote(rootDir)
+  if (!remote) {
+    return
+  }
+
+  // https://www.npmjs.com/package/git-url-parse#clipboard-example
+  const { name, owner, source } = gitUrlParse(remote)
+  const url = `https://${source}/${owner}/${name}`
+
+  return {
+    name,
+    owner,
+    url
+  }
+}
+
+async function getLocalGitRemote(dir: string): Promise<string | undefined> {
+  try {
+    const parsed = await readGitConfig(dir)
+    if (!parsed) {
+      return
+    }
+    return parsed.remote?.origin?.url
+  } catch {
+    // Ignore error
+  }
+}
+
+export function getGitEnv(): GitInfo {
+  // https://github.com/unjs/std-env/issues/59
+  const envInfo = {
+    // Provider
+    provider: process.env.VERCEL_GIT_PROVIDER // vercel
+      || (process.env.GITHUB_SERVER_URL ? 'github' : undefined) // github
+      || '',
+    // Owner
+    owner: process.env.VERCEL_GIT_REPO_OWNER // vercel
+      || process.env.GITHUB_REPOSITORY_OWNER // github
+      || process.env.CI_PROJECT_PATH?.split('/').shift() // gitlab
+      || '',
+    // Name
+    name: process.env.VERCEL_GIT_REPO_SLUG
+      || process.env.GITHUB_REPOSITORY?.split('/').pop() // github
+      || process.env.CI_PROJECT_PATH?.split('/').splice(1).join('/') // gitlab
+      || '',
+    // Url
+    url: process.env.REPOSITORY_URL || '' // netlify
+  }
+
+  if (!envInfo.url && envInfo.provider && envInfo.owner && envInfo.name) {
+    envInfo.url = `https://${envInfo.provider}.com/${envInfo.owner}/${envInfo.name}`
+  }
+
+  // If only url available (ex: Netlify)
+  if (!envInfo.name && !envInfo.owner && envInfo.url) {
+    try {
+      const { name, owner } = gitUrlParse(envInfo.url)
+      envInfo.name = name
+      envInfo.owner = owner
+    } catch {
+      // Ignore error
+    }
+  }
+
+  return {
+    name: envInfo.name,
+    owner: envInfo.owner,
+    url: envInfo.url
+  }
+}

package/utils/meta.ts

@@ -0,0 +1,29 @@
+// copy from https://github.com/nuxt-content/docus/tree/main/layer/utils
+import { readFile } from 'node:fs/promises'
+import { resolve } from 'node:path'
+
+export function inferSiteURL() {
+  // https://github.com/unjs/std-env/issues/59
+  return (
+    process.env.NUXT_SITE_URL
+    || (process.env.NEXT_PUBLIC_VERCEL_URL && `https://${process.env.NEXT_PUBLIC_VERCEL_URL}`) // Vercel
+    || process.env.URL // Netlify
+    || process.env.CI_PAGES_URL // Gitlab Pages
+    || process.env.CF_PAGES_URL // Cloudflare Pages
+  )
+}
+
+export async function getPackageJsonMetadata(dir: string) {
+  try {
+    const packageJson = await readFile(resolve(dir, 'package.json'), 'utf-8')
+    const parsed = JSON.parse(packageJson)
+    return {
+      name: parsed.name,
+      description: parsed.description
+    }
+  } catch {
+    return {
+      name: 'docs'
+    }
+  }
+}