docus 1.0.7 → 3.0.0-beta.10

package/theme/utils/navigation.ts

@@ -0,0 +1,49 @@
+import type { NavItem } from '@nuxt/content/dist/runtime/types'
+
+/**
+ * Find first child link from a navigation node.
+ */
+export const findBottomLink = (link: NavItem) => {
+  for (const child of link.children) {
+    if (!child.children)
+      return child.slug
+  }
+
+  for (const child of link.children) {
+    const result = findBottomLink(child)
+    if (result)
+      return result
+  }
+}
+
+/**
+ * Find current navigation directory from a path.
+ */
+export const navFromPath = (path: string, tree: NavItem[]) => {
+  for (const file of tree) {
+    if (file.slug === path && !file.id)
+      return file
+
+    if (file.children) {
+      const result = navFromPath(path, file.children)
+      if (result)
+        return result
+    }
+  }
+}
+
+/**
+ * Find a navigation node from a path.
+ */
+export const fileFromPath = (path: string, tree: NavItem[]) => {
+  for (const file of tree) {
+    if (file.children) {
+      const result = fileFromPath(path, file.children)
+      if (result)
+        return result
+    }
+
+    if (file.slug === path)
+      return file
+  }
+}

package/theme/utils/plugin.ts

@@ -0,0 +1,21 @@
+import { queryNavigation, queryPage, queryTheme } from './queries'
+import { defineNuxtPlugin, useRoute } from '#imports'
+
+/**
+ * Plugin enabled only in development
+ * Ensure hot reload works with content sources
+ */
+export default defineNuxtPlugin(
+  (nuxt) => {
+    nuxt.hook(
+      'app:data:refresh',
+      async () => {
+        const route = useRoute()
+
+        await queryNavigation()
+        await queryTheme()
+        await queryPage(route)
+      },
+    )
+  },
+)

package/theme/utils/queries.ts

@@ -0,0 +1,68 @@
+import { withoutTrailingSlash } from 'ufo'
+import type { ParsedContent } from '@nuxt/content/dist/runtime/types'
+import type { RouteLocationNormalized, RouteLocationNormalizedLoaded } from 'vue-router'
+import { defaultThemeConfig } from './theme'
+import { useDocusState } from './state'
+import { fetchContentNavigation, queryContent } from '#imports'
+
+export const queryPage = async (route: RouteLocationNormalized | RouteLocationNormalizedLoaded) => {
+  const path = withoutTrailingSlash(route.path)
+
+  const { page, surround } = useDocusState()
+
+  try {
+    await Promise.all([
+      queryContent().where({ slug: path }).findOne() as Promise<ParsedContent>,
+      queryContent().where({ partial: { $not: true }, navigation: { $not: false } }).findSurround(path) as Promise<ParsedContent[]>,
+    ]).then(
+      ([_page, _surround]) => {
+        if (_page)
+          page.value = _page
+        else page.value = undefined
+
+        if (_surround && _surround.length)
+          surround.value = _surround
+        else surround.value = undefined
+
+        // Handle layout update from page
+        if (_page?.layout)
+          route.meta.layout = _page?.layout
+        else
+          route.meta.layout = 'default'
+      },
+    )
+  }
+  catch (e) {
+    console.warn(`Could not find page for path ${path}!`)
+    page.value = undefined
+    surround.value = undefined
+  }
+}
+
+export const queryNavigation = async () => {
+  const { navigation } = useDocusState()
+
+  navigation.value = await fetchContentNavigation(queryContent().where({
+    navigation: {
+      $not: false,
+    },
+  }))
+}
+
+export const queryTheme = async () => {
+  const { theme } = useDocusState()
+
+  // Fetch _theme.yml at `content/` root.
+  const query = await queryContent().where({
+    id: 'content:_theme.yml',
+  }).findOne()
+
+  if (!query) {
+    // Assign default theme config if none found.
+    theme.value = defaultThemeConfig
+
+    return
+  }
+
+  theme.value = query.body
+}

package/theme/utils/state.ts

@@ -0,0 +1,33 @@
+import type { NavItem, ParsedContent } from '@nuxt/content/dist/runtime/types'
+import type { ThemeConfig } from './theme'
+import { useState } from '#imports'
+
+export const useDocusState = () => {
+  /**
+   * Navigation tree from root of app.
+   */
+  const navigation = useState<NavItem[]>('docus-navigation', () => null)
+
+  /**
+   * Current page complete data.
+   */
+  const page = useState<ParsedContent>('docus-page', () => null)
+
+  /**
+   * Previous and next page data.
+   * Format: [prev, next]
+   */
+  const surround = useState<ParsedContent[]>('docus-page-surround', () => null)
+
+  /**
+   * Theme configuration.
+   */
+  const theme = useState<ThemeConfig>('docus-theme', () => null)
+
+  return {
+    navigation,
+    page,
+    surround,
+    theme,
+  }
+}

package/theme/utils/theme.ts

@@ -0,0 +1,66 @@
+export interface ThemeIcon {
+  label: string
+  href: string
+  component: string
+}
+
+export interface ThemeDebugConfig {
+  page: boolean
+  navigation: boolean
+  theme: boolean
+}
+
+export interface ThemeConfig {
+  title: string
+  url: string
+  description: string
+  twitter: string
+  github: string
+  cover: string
+  coverAlt: string
+  header: {
+    title: false | string
+    logo: boolean | string
+  }
+  footer: {
+    credits: false | {
+      icon: string
+      text: string
+    }
+    icons: ThemeIcon[]
+  }
+  debug: boolean | ThemeDebugConfig
+}
+
+export const defaultThemeConfig: ThemeConfig = {
+  title: 'Docus',
+  url: 'https://docus.dev',
+  twitter: '@docus_',
+  github: 'nuxtlabs/docus',
+  description: 'Write pages in markdown, use Vue components and enjoy the power of Nuxt with a blazing fast developer experience.',
+  header: {
+    title: false,
+    logo: true,
+  },
+  cover: 'https://user-images.githubusercontent.com/904724/105075054-872fac80-5a89-11eb-8aab-46dd254ad986.png',
+  coverAlt: 'A screenshot of a website built with Docus with the Docus logo on top of it.',
+  footer: {
+    credits: {
+      icon: 'IconNuxtLabs',
+      text: 'Made by NuxtLabs',
+    },
+    icons: [
+      {
+        label: 'NuxtJS',
+        href: 'https://nuxtjs.org',
+        component: 'IconNuxtLabs',
+      },
+      {
+        label: 'Vue Telescope',
+        href: 'https://vuetelescope.com',
+        component: 'IconVueTelescope',
+      },
+    ],
+  },
+  debug: true,
+}

package/dist/create-docus/create-docus.js

@@ -1,7 +0,0 @@
-#!/usr/bin/env node
-// #!/usr/bin/env node
-"use strict";
-
-var _index = require("./index");
-
-(0, _index.createDocus)().catch(console.log);

package/dist/create-docus/helpers.js

@@ -1,244 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.getProjectType = getProjectType;
-exports.getTemplate = getTemplate;
-exports.createDir = createDir;
-exports.getValidPackageName = getValidPackageName;
-exports.getTargetDir = getTargetDir;
-exports.createProject = createProject;
-exports.log = exports.pkgManager = exports.args = exports.cwd = void 0;
-
-var _package = require("../../package.json");
-
-var _fs = _interopRequireDefault(require("fs"));
-
-var _path = _interopRequireDefault(require("path"));
-
-var _kolorist = require("kolorist");
-
-var _minimist = _interopRequireDefault(require("minimist"));
-
-var _prompts = _interopRequireDefault(require("prompts"));
-
-var _degit = _interopRequireDefault(require("degit"));
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-const cwd = process.cwd();
-exports.cwd = cwd;
-const args = (0, _minimist.default)(process.argv.slice(2));
-exports.args = args;
-const pkgManager = /pnpm/.test(process.env.npm_execpath || "") || /pnpm/.test(process.env.npm_config_user_agent || "") ? "pnpm" : /yarn/.test(process.env.npm_execpath || "") ? "yarn" : "npm";
-exports.pkgManager = pkgManager;
-const log = {
-  space: () => console.log(),
-  bold: str => (0, _kolorist.bold)(str),
-  primary: str => (0, _kolorist.green)(str),
-  secondary: str => (0, _kolorist.dim)(str),
-  warning: str => (0, _kolorist.yellow)(str),
-  error: str => (0, _kolorist.red)(str),
-  broadcast: str => console.log(`  ${str}`),
-  motd: () => {
-    log.space();
-    log.broadcast(`${(0, _kolorist.bold)("Docus") + log.secondary(" CLI")} ${log.primary(`v${_package.version}`)}`);
-    log.space();
-  }
-};
-exports.log = log;
-const REPOSITORIES = {
-  website: "git@github.com:docusgen/starter.git",
-  theme: "git@github.com:docusgen/theme-starter.git",
-  module: "git@github.com:docusgen/module-starter.git"
-};
-
-function copyDir(srcDir, destDir) {
-  _fs.default.mkdirSync(destDir, {
-    recursive: true
-  });
-
-  for (const file of _fs.default.readdirSync(srcDir)) {
-    const srcFile = _path.default.resolve(srcDir, file);
-
-    const destFile = _path.default.resolve(destDir, file);
-
-    copy(srcFile, destFile);
-  }
-}
-
-function emptyDir(dir) {
-  if (!_fs.default.existsSync(dir)) return;
-
-  for (const file of _fs.default.readdirSync(dir)) {
-    const abs = _path.default.resolve(dir, file);
-
-    if (_fs.default.lstatSync(abs).isDirectory()) {
-      emptyDir(abs);
-
-      _fs.default.rmdirSync(abs);
-    } else {
-      _fs.default.unlinkSync(abs);
-    }
-  }
-}
-
-function copy(src, dest) {
-  const stat = _fs.default.statSync(src);
-
-  if (stat.isDirectory()) copyDir(src, dest);else _fs.default.copyFileSync(src, dest);
-}
-
-function getProjectType() {
-  switch (args["type"]) {
-    case "theme":
-      return "theme";
-
-    case "module":
-      return "module";
-
-    default:
-      return "website";
-  }
-}
-
-async function getTemplate(projectType) {
-  const {
-    broadcast,
-    primary,
-    secondary
-  } = log;
-
-  const templateDir = _path.default.join(__dirname, "./template");
-
-  broadcast([secondary("Cloning the latest"), primary(projectType === "website" ? "Docus" : projectType), secondary("template...")].join(" "));
-  emptyDir(templateDir);
-  const projectRepository = REPOSITORIES[projectType];
-  const repo = (0, _degit.default)(projectRepository, {
-    force: true,
-    verbose: true,
-    mode: "git"
-  });
-  await repo.clone(templateDir);
-  return templateDir;
-}
-
-async function createDir(targetDir) {
-  const projectPath = _path.default.join(cwd, targetDir);
-
-  const {
-    broadcast,
-    warning,
-    error,
-    space,
-    secondary
-  } = log;
-
-  if (!_fs.default.existsSync(projectPath)) {
-    _fs.default.mkdirSync(projectPath, {
-      recursive: true
-    });
-  } else {
-    const existing = _fs.default.readdirSync(projectPath);
-
-    const dir = projectPath.split("/");
-    const dirName = dir[dir.length - 1];
-
-    if (existing.length) {
-      space();
-      broadcast(warning(`Target directory "${dirName}" is not empty.`));
-      space();
-      const {
-        yes
-      } = await (0, _prompts.default)({
-        type: "confirm",
-        name: "yes",
-        initial: "Y",
-        message: "Remove existing files and continue?"
-      });
-      if (yes) emptyDir(projectPath);else {
-        space();
-        broadcast(warning(`Target directory is not empty and you do not want to overwrite it.`));
-        space();
-        broadcast(error(`Cancelling project creation.`));
-        process.exit(1);
-      }
-    }
-  }
-
-  space();
-  broadcast(secondary("Scaffolding project in ") + targetDir + secondary("..."));
-  return projectPath;
-}
-
-async function getValidPackageName(projectName) {
-  projectName = _path.default.basename(projectName);
-  const packageNameRegExp = /^(?:@[a-z0-9-*~][a-z0-9-*._~]*\/)?[a-z0-9-~][a-z0-9-._~]*$/;
-
-  if (packageNameRegExp.test(projectName)) {
-    return projectName;
-  } else {
-    const suggestedPackageName = projectName.trim().toLowerCase().replace(/\s+/g, "-").replace(/^[._]/, "").replace(/[^a-z0-9-~]+/g, "-");
-    const {
-      inputPackageName
-    } = await (0, _prompts.default)({
-      type: "text",
-      name: "inputPackageName",
-      message: "Package name:",
-      initial: suggestedPackageName,
-      validate: input => packageNameRegExp.test(input) ? true : "Invalid package.json name"
-    });
-    return inputPackageName;
-  }
-}
-
-async function getTargetDir(projectType) {
-  const {
-    space,
-    broadcast,
-    error,
-    warning
-  } = log;
-  let targetDir = args._[0];
-
-  if (!targetDir) {
-    const {
-      projectName
-    } = await (0, _prompts.default)({
-      type: "text",
-      name: "projectName",
-      message: "Project name:",
-      initial: `my-${projectType}`
-    });
-
-    if (!projectName) {
-      space();
-      broadcast(warning(`You must specify a project name.`));
-      space();
-      broadcast(error(`Cancelling project creation.`));
-      process.exit(1);
-    }
-
-    targetDir = projectName.trim();
-  }
-
-  return targetDir;
-}
-
-function createProject(root, templateDir, packageName) {
-  const write = (file, content = void 0) => {
-    const targetPath = _path.default.join(root, file);
-
-    if (content) _fs.default.writeFileSync(targetPath, content);else copy(_path.default.join(templateDir, file), targetPath);
-  };
-
-  const files = _fs.default.readdirSync(templateDir);
-
-  for (const file of files.filter(f => f !== "package.json")) write(file);
-
-  const pkg = require(_path.default.join(templateDir, "package.json"));
-
-  pkg.name = packageName;
-  write("package.json", JSON.stringify(pkg, null, 2));
-}

package/dist/create-docus/index.js

@@ -1,87 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.createDocus = createDocus;
-
-var _path = require("path");
-
-var _prompts = _interopRequireDefault(require("prompts"));
-
-var _execa = _interopRequireDefault(require("execa"));
-
-var _helpers = require("./helpers");
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-const {
-  motd,
-  primary,
-  secondary,
-  warning,
-  bold,
-  space,
-  broadcast
-} = _helpers.log;
-
-async function createDocus() {
-  motd();
-  const projectType = (0, _helpers.getProjectType)();
-  const targetDir = await (0, _helpers.getTargetDir)(projectType);
-  const packageName = await (0, _helpers.getValidPackageName)(targetDir);
-  const projectPath = await (0, _helpers.createDir)(targetDir);
-  const templateDir = await (0, _helpers.getTemplate)(projectType);
-  (0, _helpers.createProject)(projectPath, templateDir, packageName);
-  broadcast(primary("Done."));
-  space();
-  const {
-    yes
-  } = await (0, _prompts.default)({
-    type: "confirm",
-    name: "yes",
-    initial: "Y",
-    message: "Install and start it now?"
-  });
-  if (yes) await startProject(projectPath);else startItLater(projectPath);
-}
-
-async function startProject(projectPath) {
-  space();
-  const {
-    agent
-  } = await (0, _prompts.default)({
-    name: "agent",
-    type: "select",
-    message: "Choose the agent",
-    choices: ["yarn", "npm", "pnpm"].map(i => ({
-      value: i,
-      title: i
-    }))
-  });
-
-  if (!agent) {
-    space();
-    broadcast(warning(`You cancelled the agent selection!`));
-    return startItLater(projectPath);
-  }
-
-  await (0, _execa.default)(agent, ["install"], {
-    stdio: "inherit",
-    cwd: projectPath
-  });
-  await (0, _execa.default)(agent, ["run", "dev"], {
-    stdio: "inherit",
-    cwd: projectPath
-  });
-}
-
-function startItLater(projectPath) {
-  space();
-  broadcast(secondary("Start it later with:"));
-  space();
-  const dir = (0, _path.relative)(_helpers.cwd, projectPath);
-  if (projectPath !== _helpers.cwd) broadcast(primary(`cd ${bold(dir)}`));
-  broadcast(primary(`${_helpers.pkgManager === "yarn" ? "yarn" : `${_helpers.pkgManager} install`}`));
-  broadcast(primary(`${_helpers.pkgManager === "yarn" ? "yarn dev" : `${_helpers.pkgManager} run dev`}`));
-}

package/dist/index.js

@@ -1,10 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-module.exports = void 0;
-
-var _default = () => {};
-
-module.exports = _default;