You can import and execute the docmd build engine programmatically from Node.js applications. This enables custom build pipelines, automated documentation generation, and monorepo integrations.

Installation

Ensure @docmd/core is installed in your project:

npm install @docmd/core

Primary Build Export Functions

buildSite(configPath, options)

Executes standard static site compilation:

import { buildSite } from "@docmd/core";

async function runBuild() {
  await buildSite("./docmd.config.json", {
    isDev: false,
    offline: false,
    zeroConfig: false
  });
}

buildLive(options)

Compiles the browser-based Live Editor application:

import { buildLive } from "@docmd/core";

async function generateEditor() {
  await buildLive({
    serve: false,
    port: 3000
  });
}

Workspace Functions

Functions for managing multi-project workspaces programmatically:

• isWorkspace(config): Evaluates whether a configuration object conforms to workspace schemas.
• detectWorkspace(configPath): Resolves workspace configurations, returning normalised WorkspaceRootConfig or null.
• buildWorkspace(config, options): Compiles all projects defined in a workspace root.
• devWorkspace(config, options): Starts workspace development server with targeted rebuild tracking.

import { detectWorkspace, buildWorkspace } from "@docmd/core";

async function buildAllWorkspaces() {
  const config = await detectWorkspace("./docmd.config.json");
  if (config) {
    await buildWorkspace(config, { quiet: false });
  }
}

Custom Pipeline Example

Compose docmd compilation with custom build scripts:

import { buildSite } from "@docmd/core";
import fs from "fs-extra";

async function deployPipeline() {
  // 1. Generate dynamic content sources
  await fs.writeFile("./docs/dynamic.md", "# Dynamically Generated Page");

  // 2. Execute static compilation
  await buildSite("./docmd.config.json");

  // 3. Move output directory
  await fs.move("./site", "./public/docs");
}