docus 3.0.0-beta.8 → 3.0.0

package/dist/main.mjs

@@ -0,0 +1,242 @@
+#!/usr/bin/env node
+
+// cli/main.ts
+import * as dotenv from "dotenv";
+
+// cli/cli.ts
+import { resolve as resolve2 } from "path";
+import { defineCommand, runMain } from "citty";
+
+// cli/setup.ts
+import { fileURLToPath } from "url";
+import { resolve } from "path";
+import { readFile } from "fs/promises";
+
+// cli/git.ts
+import { execSync } from "child_process";
+import { readGitConfig } from "pkg-types";
+import gitUrlParse from "git-url-parse";
+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").toString().trim();
+    if (branch && branch !== "HEAD") {
+      return branch;
+    }
+  } catch {
+    return "main";
+  }
+}
+async function getLocalGitInfo(rootDir) {
+  const remote = await getLocalGitRemote(rootDir);
+  if (!remote) {
+    return;
+  }
+  const { name, owner, source } = gitUrlParse(remote);
+  const url = `https://${source}/${owner}/${name}`;
+  return {
+    name,
+    owner,
+    url
+  };
+}
+async function getLocalGitRemote(dir) {
+  var _a, _b;
+  try {
+    const parsed = await readGitConfig(dir);
+    if (!parsed) {
+      return;
+    }
+    return (_b = (_a = parsed.remote) == null ? void 0 : _a["origin"]) == null ? void 0 : _b.url;
+  } catch {
+  }
+}
+function getGitEnv() {
+  var _a, _b, _c;
+  const envInfo = {
+    // Provider
+    provider: process.env.VERCEL_GIT_PROVIDER || (process.env.GITHUB_SERVER_URL ? "github" : void 0) || "",
+    // Owner
+    owner: process.env.VERCEL_GIT_REPO_OWNER || process.env.GITHUB_REPOSITORY_OWNER || ((_a = process.env.CI_PROJECT_PATH) == null ? void 0 : _a.split("/").shift()) || "",
+    // Name
+    name: process.env.VERCEL_GIT_REPO_SLUG || ((_b = process.env.GITHUB_REPOSITORY) == null ? void 0 : _b.split("/").pop()) || ((_c = process.env.CI_PROJECT_PATH) == null ? void 0 : _c.split("/").splice(1).join("/")) || "",
+    // 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 (!envInfo.name && !envInfo.owner && envInfo.url) {
+    try {
+      const { name, owner } = gitUrlParse(envInfo.url);
+      envInfo.name = name;
+      envInfo.owner = owner;
+    } catch {
+    }
+  }
+  return {
+    name: envInfo.name,
+    owner: envInfo.owner,
+    url: envInfo.url
+  };
+}
+
+// cli/setup.ts
+var appDir = fileURLToPath(new URL("../app", import.meta.url));
+var pkgDir = fileURLToPath(new URL("..", import.meta.url));
+async function getNuxtConfig(dir, _opts = {}) {
+  const meta = await getPackageJsonMetadata(dir);
+  const fixLayers = (_, nuxt) => {
+    const hasDocsDir = nuxt.options._layers.some((layer) => layer.cwd === dir);
+    if (!hasDocsDir) {
+      nuxt.options._layers.unshift({
+        cwd: dir,
+        config: {
+          rootDir: dir,
+          srcDir: dir
+        }
+      });
+    }
+  };
+  global.__DOCS_DIR__ = resolve(dir, "content");
+  const gitInfo = await getLocalGitInfo(dir) || getGitEnv();
+  const url = inferSiteURL();
+  return {
+    compatibilityDate: "2025-04-24",
+    extends: [appDir],
+    modulesDir: [resolve(pkgDir, "node_modules"), resolve(appDir, "node_modules")],
+    modules: ["nuxt-llms", fixLayers],
+    appConfig: {
+      header: {
+        title: meta.name || ""
+      },
+      github: {
+        owner: gitInfo == null ? void 0 : gitInfo.owner,
+        name: gitInfo == null ? void 0 : gitInfo.name,
+        url: gitInfo == null ? void 0 : gitInfo.url,
+        branch: getGitBranch()
+      },
+      seo: {
+        titleTemplate: `%s - ${meta.name}`,
+        title: meta.name || "",
+        description: meta.description || ""
+      },
+      toc: {}
+    },
+    site: {
+      url,
+      name: meta.name || ""
+    },
+    llms: {
+      domain: url,
+      title: meta.name || "",
+      description: meta.description || "",
+      full: {
+        title: meta.name || "",
+        description: meta.description || ""
+      }
+    },
+    future: {
+      compatibilityVersion: 4
+    }
+  };
+}
+function inferSiteURL() {
+  return process.env.NUXT_SITE_URL || process.env.NEXT_PUBLIC_VERCEL_URL && `https://${process.env.NEXT_PUBLIC_VERCEL_URL}` || process.env.URL || process.env.CI_PAGES_URL || process.env.CF_PAGES_URL;
+}
+async function getPackageJsonMetadata(dir) {
+  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"
+    };
+  }
+}
+
+// cli/cli.ts
+function createCLI(opts) {
+  const sharedArgs = {
+    dir: {
+      type: "positional",
+      description: "Docs directory",
+      required: true,
+      default: "."
+    }
+  };
+  const init = defineCommand({
+    meta: {
+      name: "init",
+      description: "Initialize a fresh Docus project"
+    },
+    args: { ...sharedArgs },
+    async setup({ args }) {
+      const dir = resolve2(args.dir);
+      const { runCommand } = await import("nuxi");
+      await runCommand("init", [dir, "-t", "gh:nuxtlabs/docus/.starter", dir]);
+    }
+  });
+  const dev = defineCommand({
+    meta: {
+      name: "dev",
+      description: "Start docs in development mode"
+    },
+    args: { ...sharedArgs },
+    async setup({ args }) {
+      const dir = resolve2(args.dir);
+      const nuxtConfig = await getNuxtConfig(dir, {
+        ...opts.setup,
+        dev: true
+      });
+      const { runCommand } = await import("nuxi");
+      await runCommand("dev", [dir, "--no-fork", "--port", process.env.PORT || "4000"], { overrides: nuxtConfig });
+    }
+  });
+  const build = defineCommand({
+    meta: {
+      name: "build",
+      description: "Build docs for production"
+    },
+    args: { ...sharedArgs },
+    async setup({ args }) {
+      const dir = resolve2(args.dir);
+      const nuxtConfig = await getNuxtConfig(dir, opts.setup);
+      const { runCommand } = await import("nuxi");
+      await runCommand("build", [dir], { overrides: nuxtConfig });
+    }
+  });
+  const main = defineCommand({
+    meta: {
+      name: opts.name,
+      description: opts.description
+    },
+    subCommands: {
+      init,
+      dev,
+      build
+    }
+  });
+  return {
+    runMain: () => runMain(main)
+  };
+}
+
+// cli/main.ts
+dotenv.config();
+var cli = createCLI({
+  name: "Docus",
+  description: "Docus Docs CLI",
+  setup: {
+    defaults: {}
+  }
+});
+cli.runMain();

package/package.json

@@ -1,47 +1,74 @@
 {
-  "version": "3.0.0-beta.8",
   "name": "docus",
-  "scripts": {
-    "build": "nuxi build",
-    "dev": "nuxi dev",
-    "preview": "nuxi preview",
-    "lint": "eslint --ext .ts,.js,.vue,.css ."
+  "description": "Minimal Documentation theme and CLI for shared usage across Nuxt modules",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/nuxtlabs/docus"
   },
-  "devDependencies": {
-    "@antfu/eslint-config": "^0.21.1",
-    "@nuxtjs/eslint-config-typescript": "^9.0.0",
-    "eslint": "^8.14.0",
-    "jiti": "^1.13.0",
-    "nuxt": "npm:nuxt3@latest",
-    "parse-entities": "^4.0.0",
-    "typescript": "^4.6.4"
+  "private": false,
+  "version": "3.0.0",
+  "keywords": [],
+  "license": "MIT",
+  "bin": {
+    "docus": "./dist/main.mjs"
+  },
+  "files": [
+    "app",
+    "dist",
+    "!app/**/node_modules",
+    "!app/**/.nuxt",
+    "!app/**/tsconfig.json"
+  ],
+  "scripts": {
+    "dev": "npm run docs:dev",
+    "docs:dev": "NUXT_DOCS_DEV=1 npm run docus dev docs",
+    "docs:build": "npm run docus build docs",
+    "dev:prepare": "nuxi prepare app && nuxi prepare docs",
+    "build": "tsup-node ./cli/main.ts --format esm",
+    "docus": "tsx ./cli/main.ts",
+    "test": "echo \"Error: no test specified\"",
+    "lint": "eslint .",
+    "release": "npm run lint && npm run test && npm run build && release-it"
   },
   "dependencies": {
-    "@iconify/vue": "^3.2.1",
-    "@nuxt/content": "npm:@nuxt/content-edge@latest",
-    "@nuxthq/admin": "npm:@nuxthq/admin-edge@latest",
-    "@nuxtjs/color-mode": "^3.0.2",
-    "@nuxtjs/tailwindcss": "^5.0.3",
-    "@tailwindcss/aspect-ratio": "^0.4.0",
-    "@tailwindcss/forms": "^0.5.0",
-    "@tailwindcss/line-clamp": "^0.4.0",
-    "@tailwindcss/typography": "^0.5.2",
-    "@vueuse/core": "^8.3.1",
-    "@vueuse/motion": "2.0.0-beta.12",
-    "@vueuse/nuxt": "^8.3.1",
-    "clipboard": "^2.0.10",
-    "defu": "^6.0.0",
-    "lodash-es": "^4.17.21",
-    "tailwindcss": "^3.0.24",
-    "vue-plausible": "^1.3.1"
+    "@iconify-json/lucide": "^1.2.47",
+    "@iconify-json/simple-icons": "^1.2.38",
+    "@iconify-json/vscode-icons": "^1.2.22",
+    "@nuxt/content": "^3.6.0",
+    "@nuxt/image": "^1.10.0",
+    "@nuxt/kit": "^3.17.5",
+    "@nuxt/ui-pro": "^3.1.3",
+    "@nuxtjs/robots": "^5.2.10",
+    "c12": "^3.0.4",
+    "citty": "^0.1.6",
+    "dotenv": "^16.5.0",
+    "git-url-parse": "^16.1.0",
+    "minimark": "^0.2.0",
+    "motion-v": "^1.2.1",
+    "nuxi": "^3.25.1",
+    "nuxt-llms": "^0.1.3",
+    "nuxt-og-image": "^5.1.6",
+    "pkg-types": "^2.1.0",
+    "tailwindcss": "^4.1.8",
+    "ufo": "^1.6.1",
+    "unctx": "^2.4.1"
+  },
+  "devDependencies": {
+    "@nuxt/eslint-config": "^1.4.1",
+    "@release-it/conventional-changelog": "^10.0.1",
+    "@stylistic/eslint-plugin": "^4.4.1",
+    "@types/node": "^24.0.0",
+    "@typescript-eslint/parser": "^8.34.0",
+    "changelogen": "^0.6.1",
+    "eslint": "^9.28.0",
+    "release-it": "^19.0.3",
+    "tsup": "^8.5.0",
+    "tsx": "^4.19.4",
+    "typescript": "^5.8.3"
   },
-  "main": "./nuxt.config.ts",
-  "exports": {
-    "./theme": "./theme/nuxt.config.ts",
-    "./theme/*": "./theme/*/*.*"
+  "peerDependencies": {
+    "better-sqlite3": "11.x",
+    "nuxt": "3.x"
   },
-  "files": [
-    "README.md",
-    "theme"
-  ]
+  "packageManager": "pnpm@10.12.1"
 }

package/theme/app/router.options.ts

@@ -1,18 +0,0 @@
-import type { RouterConfig } from '@nuxt/schema'
-
-// https://router.vuejs.org/api/#routeroptions
-export default <RouterConfig>{
-  scrollBehavior: (to) => {
-    if (to.params?.smooth) {
-      return {
-        el: to.params?.smooth,
-        behavior: 'smooth',
-      }
-    }
-
-    // Scroll to top of window
-    window.scrollTo({
-      top: 0,
-    })
-  },
-}

package/theme/assets/css/fonts.css

@@ -1,84 +0,0 @@
-/* `font-light` */
-@font-face {
-  font-family: "RoobertPRO";
-  src: url("/fonts/RoobertPRO-Light.woff2") format("woff2"),
-       url("/fonts/RoobertPRO-Light.woff") format("woff");
-  font-weight: 300;
-} 
-@font-face {
-  font-family: "RoobertPRO";
-  src: url("/fonts/RoobertPRO-LightItalic.woff2") format("woff2"),
-       url("/fonts/RoobertPRO-LightItalic.woff") format("woff");
-  font-weight: 300;
-  font-style: italic;
-}
-/* `font-normal` */
-@font-face {
-  font-family: "RoobertPRO";
-  src: url("/fonts/RoobertPRO-Regular.woff2") format("woff2"),
-       url("/fonts/RoobertPRO-Regular.woff") format("woff");
-  font-weight: 400;
-}
-@font-face {
-  font-family: "RoobertPRO";
-  src: url("/fonts/RoobertPRO-RegularItalic.woff2") format("woff2"),
-       url("/fonts/RoobertPRO-RegularItalic.woff") format("woff");
-  font-weight: 400;
-  font-style: italic;
-}
-/* `font-medium */
-@font-face {
-  font-family: "RoobertPRO";
-  src: url("/fonts/RoobertPRO-Medium.woff2") format("woff2"),
-       url("/fonts/RoobertPRO-Medium.woff") format("woff");
-  font-weight: 500;
-}
-@font-face {
-  font-family: "RoobertPRO";
-  src: url("/fonts/RoobertPRO-MediumItalic.woff2") format("woff2"),
-       url("/fonts/RoobertPRO-MediumItalic.woff") format("woff");
-  font-weight: 500;
-  font-style: italic;
-}
-/* `font-semibold` */
-@font-face {
-  font-family: "RoobertPRO";
-  src: url("/fonts/RoobertPRO-SemiBold.woff2") format("woff2"),
-       url("/fonts/RoobertPRO-SemiBold.woff") format("woff");
-  font-weight: 600;
-}
-@font-face {
-  font-family: "RoobertPRO";
-  src: url("/fonts/RoobertPRO-SemiBoldItalic.woff2") format("woff2"),
-       url("/fonts/RoobertPRO-SemiBoldItalic.woff") format("woff");
-  font-weight: 600;
-  font-style: italic;
-}
-/* `font-bold` */
-@font-face {
-  font-family: "RoobertPRO";
-  src: url("/fonts/RoobertPRO-Bold.woff2") format("woff2"),
-       url("/fonts/RoobertPRO-Bold.woff") format("woff");
-  font-weight: 700;
-}
-@font-face {
-  font-family: "RoobertPRO";
-  src: url("/fonts/RoobertPRO-BoldItalic.woff2") format("woff2"),
-       url("/fonts/RoobertPRO-BoldItalic.woff") format("woff");
-  font-weight: 700;
-  font-style: italic;
-}
-/* `font-extrabold` */
-@font-face {
-  font-family: "RoobertPRO";
-  src: url("/fonts/RoobertPRO-Heavy.woff2") format("woff2"),
-       url("/fonts/RoobertPRO-Heavy.woff") format("woff");
-  font-weight: 800;
-}
-@font-face {
-  font-family: "RoobertPRO";
-  src: url("/fonts/RoobertPRO-HeavyItalic.woff2") format("woff2"),
-       url("/fonts/RoobertPRO-HeavyItalic.woff") format("woff");
-  font-weight: 800;
-  font-style: italic;
-}

package/theme/assets/css/main.css

@@ -1,104 +0,0 @@
-@tailwind base;
-@tailwind components;
-@tailwind utilities;
-
-/* Variables */
-:root {
-  --header-height: 4rem;
-  --codeblocks-background: theme('colors.gray.900');
-}
-
-@layer components {
-  /* Text primary */
-
-  .text-primary {
-    @apply text-gray-900 dark:text-gray-50;
-  }
-
-  /* Text secondary */
-
-  .text-secondary {
-    @apply text-gray-500 dark:text-gray-400;
-  }
-
-  .text-secondary-active {
-    @apply text-primary-500 dark:text-primary-400;
-  }
-
-  .text-secondary-hover {
-    @apply hover:text-primary-500 hover:dark:text-primary-400;
-  }
-
-  .text-secondary-group-hover {
-    @apply group-hover:dark:text-primary-400 group-hover:text-primary-500;
-  }
-
-  /* Transitions */
-
-  .transition-base {
-    @apply transition-colors transition-opacity duration-100 ease-in-out;
-  }
-
-  /* Surface */
-
-  .surface {
-    @apply dark:bg-gray-900 bg-white;
-  }
-
-  .surface-secondary {
-    @apply bg-gray-500 dark:bg-gray-400;
-  }
-
-  .blurry-surface {
-    @apply backdrop-blur bg-white/95 dark:bg-gray-900/95;
-  }
-
-  /* Borders */
-
-  .surface-border {
-    @apply border-gray-200 dark:border-gray-800;
-  }
-
-  .surface-border-hover {
-    @apply border-primary-200 dark:border-gray-700;
-  }
-
-  .surface-border-header {
-    @apply border-b border-gray-200 dark:border-gray-800 border-opacity-50;
-  }
-
-  /* Icons */
-
-  .icon-base {
-    @apply transition-base text-secondary text-secondary-hover;
-  }
-
-  /* Code blocks */
-
-  .code-background {
-    /* background-color: var(--codeblocks-background); */
-    @apply bg-gray-800;
-  }
-
-  /* Images */
-
-  .light-img {
-    @apply dark:hidden;
-  }
-
-  .dark-img {
-    @apply hidden;
-  }
-}
-
-html {
-  @apply text-primary bg-white overflow-y-scroll;
-
-  &.dark {
-    @apply bg-gray-900;
-  }
-}
-
-body {
-  @apply antialiased font-sans text-gray-700 dark:text-gray-200;
-}

package/theme/components/app/Container.vue

@@ -1,25 +0,0 @@
-<script setup lang="ts">
-import { classNames, computed } from '#imports'
-
-const props = defineProps({
-  padded: {
-    type: Boolean,
-    default: false,
-  },
-  constrained: {
-    type: Boolean,
-    default: true,
-  },
-})
-
-const containerClass = computed(() => classNames(
-  'mx-auto max-w-7xl px-4 sm:px-6',
-  props.padded && 'px-4',
-))
-</script>
-
-<template>
-  <div :class="containerClass">
-    <slot />
-  </div>
-</template>

package/theme/components/app/Footer.vue

@@ -1,40 +0,0 @@
-<script setup lang="ts">
-import { computed, useDocus } from '#imports'
-
-const { theme } = useDocus()
-
-const icons = computed(() => theme.value?.footer?.icons || [])
-</script>
-
-<template>
-  <footer class="py-6 sm:py-0 bg-gray-50 dark:bg-gray-800 dark:bg-opacity-25 h-[8rem] sm:h-[4rem]">
-    <Container class="flex h-full flex-col gap-y-4 sm:flex-row justify-between items-center">
-      <a
-        v-if="theme.footer.credits"
-        href="https://nuxtlabs.com"
-        rel="noopener"
-        target="_blank"
-        class="flex items-end text-secondary transition-base dark:hover:text-gray-100 hover:text-gray-600 mb-3 sm:mb-0"
-      >
-        <IconNuxtLabs class="mr-2" />
-        <p class="font-semibold text-sm">Made by Nuxt Labs</p>
-      </a>
-
-      <div class="flex">
-        <a
-          v-for="icon in icons"
-          :key="icon.label"
-          rel="noopener"
-          :aria-label="icon.label"
-          :href="icon.href"
-          target="_blank"
-          class="text-sm flex items-center font-medium p-1 icon-base"
-        >
-          <Component :is="icon.component" class="w-8 h-8" />
-        </a>
-
-        <SocialIcons size="w-8 h-8" padding="p-1" />
-      </div>
-    </Container>
-  </footer>
-</template>