feat: enhance CLI with new config options for metadata and branding, update generateConfig to reflect changes

DevRohit06 · DevRohit06 · commit c4ffb37ddacf · 2026-01-02T00:27:48.000+05:30
diff --git a/.gitignore b/.gitignore
@@ -1,4 +1,4 @@
-node_modules/
+node_modules
 dist/
 .DS_Store
 *.log
diff --git a/.npmignore b/.npmignore
@@ -0,0 +1,4 @@
+.github
+.gitignore
+CHANGELOG.md
+package-lock.json
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,6 +5,28 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.3.5] - 2026-01-02
+
+### Added
+
+- **CLI Config Options**: New command-line options for configuring documentation metadata and branding
+  - `--name <name>` - Set project name directly from CLI
+  - `--description <description>` - Set project description
+  - `--primary-color <color>` - Set primary theme color (hex format)
+  - `--accent-color <color>` - Set accent theme color (hex format)
+  - `--favicon <path>` - Set favicon path
+  - `--logo <path>` - Set logo path
+- **Enhanced Config Management**: CLI options now automatically update `docs-config.json` during build/dev/eject operations
+
+### Removed
+
+- **Unused Dependency**: Removed `zod` package (was not being used, reduces bundle size)
+
+### Improved
+
+- **Cleaner Dependencies**: Only 8 essential packages now (from 9)
+- **CLI Usability**: No need to manually edit `docs-config.json` for basic configuration
+
 ## [0.3.0] - 2026-01-01
 
 ### Added
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@devrohit06/superdocs",
-  "version": "0.3.0",
+  "version": "0.3.5",
   "description": "The open-source Mintlify alternative. Beautiful documentation sites from Markdown.",
   "main": "src/index.js",
   "type": "module",
@@ -32,7 +32,6 @@
     "commander": "^12.1.0",
     "execa": "^9.0.0",
     "fs-extra": "^11.2.0",
-    "picocolors": "^1.1.1",
-    "zod": "^3.23.0"
+    "picocolors": "^1.1.1"
   }
-}
+}
diff --git a/src/cli.js b/src/cli.js
@@ -1,71 +1,114 @@
-import { Command } from 'commander';
-import pc from 'picocolors';
-import { buildCommand } from './commands/build.js';
-import { devCommand } from './commands/dev.js';
-import { ejectCommand } from './commands/eject.js';
-import { templateListCommand, templateCacheCommand } from './commands/template.js';
+import { Command } from "commander";
+import pc from "picocolors";
+import { buildCommand } from "./commands/build.js";
+import { devCommand } from "./commands/dev.js";
+import { ejectCommand } from "./commands/eject.js";
+import {
+  templateListCommand,
+  templateCacheCommand,
+} from "./commands/template.js";
 
 export async function cli() {
   const program = new Command();
 
   program
-    .name('superdocs')
-    .description('The open-source Mintlify alternative. Beautiful docs from Markdown.')
-    .version('0.3.0');
+    .name("superdocs")
+    .description(
+      "The open-source Mintlify alternative. Beautiful docs from Markdown."
+    )
+    .version("0.3.5");
 
   program
-    .command('build')
-    .description('Build the documentation site')
-    .requiredOption('-i, --input <path>', 'Path to the docs folder')
-    .option('-o, --output <path>', 'Output directory for the built site', './dist')
-    .option('-t, --template <name>', 'Template to use (default, github:owner/repo, or local path)', 'default')
-    .option('-b, --base-url <url>', 'Base URL for the site', '/')
-    .option('--search', 'Enable search functionality', false)
-    .option('--refresh', 'Force re-download template (bypass cache)', false)
+    .command("build")
+    .description("Build the documentation site")
+    .requiredOption("-i, --input <path>", "Path to the docs folder")
+    .option(
+      "-o, --output <path>",
+      "Output directory for the built site",
+      "./dist"
+    )
+    .option(
+      "-t, --template <name>",
+      "Template to use (default, github:owner/repo, or local path)",
+      "default"
+    )
+    .option("-b, --base-url <url>", "Base URL for the site", "/")
+    .option("--name <name>", "Project name")
+    .option("--description <description>", "Project description")
+    .option("--primary-color <color>", "Primary theme color (hex)")
+    .option("--accent-color <color>", "Accent theme color (hex)")
+    .option("--favicon <path>", "Favicon path")
+    .option("--logo <path>", "Logo path")
+    .option("--search", "Enable search functionality", false)
+    .option("--refresh", "Force re-download template (bypass cache)", false)
     .action(buildCommand);
 
   program
-    .command('dev')
-    .description('Start development server with watch mode')
-    .requiredOption('-i, --input <path>', 'Path to the docs folder')
-    .option('-t, --template <name>', 'Template to use (default, github:owner/repo, or local path)', 'default')
-    .option('-b, --base-url <url>', 'Base URL for the site', '/')
-    .option('--search', 'Enable search functionality', false)
-    .option('-p, --port <number>', 'Port for dev server', '4321')
-    .option('--refresh', 'Force re-download template (bypass cache)', false)
+    .command("dev")
+    .description("Start development server with watch mode")
+    .requiredOption("-i, --input <path>", "Path to the docs folder")
+    .option(
+      "-t, --template <name>",
+      "Template to use (default, github:owner/repo, or local path)",
+      "default"
+    )
+    .option("-b, --base-url <url>", "Base URL for the site", "/")
+    .option("--name <name>", "Project name")
+    .option("--description <description>", "Project description")
+    .option("--primary-color <color>", "Primary theme color (hex)")
+    .option("--accent-color <color>", "Accent theme color (hex)")
+    .option("--favicon <path>", "Favicon path")
+    .option("--logo <path>", "Logo path")
+    .option("--search", "Enable search functionality", false)
+    .option("-p, --port <number>", "Port for dev server", "4321")
+    .option("--refresh", "Force re-download template (bypass cache)", false)
     .action(devCommand);
 
   program
-    .command('eject')
-    .description('Export the full Astro project source code')
-    .requiredOption('-i, --input <path>', 'Path to the docs folder')
-    .option('-o, --output <path>', 'Output directory for the project', './astro-docs-project')
-    .option('-t, --template <name>', 'Template to use (default, github:owner/repo, or local path)', 'default')
-    .option('-b, --base-url <url>', 'Base URL for the site', '/')
-    .option('--search', 'Enable search functionality', false)
-    .option('--refresh', 'Force re-download template (bypass cache)', false)
+    .command("eject")
+    .description("Export the full Astro project source code")
+    .requiredOption("-i, --input <path>", "Path to the docs folder")
+    .option(
+      "-o, --output <path>",
+      "Output directory for the project",
+      "./astro-docs-project"
+    )
+    .option(
+      "-t, --template <name>",
+      "Template to use (default, github:owner/repo, or local path)",
+      "default"
+    )
+    .option("-b, --base-url <url>", "Base URL for the site", "/")
+    .option("--name <name>", "Project name")
+    .option("--description <description>", "Project description")
+    .option("--primary-color <color>", "Primary theme color (hex)")
+    .option("--accent-color <color>", "Accent theme color (hex)")
+    .option("--favicon <path>", "Favicon path")
+    .option("--logo <path>", "Logo path")
+    .option("--search", "Enable search functionality", false)
+    .option("--refresh", "Force re-download template (bypass cache)", false)
     .action(ejectCommand);
 
   // Template management commands
   const templateCmd = program
-    .command('template')
-    .description('Manage documentation templates');
+    .command("template")
+    .description("Manage documentation templates");
 
   templateCmd
-    .command('list')
-    .description('List available templates')
+    .command("list")
+    .description("List available templates")
     .action(templateListCommand);
 
   templateCmd
-    .command('cache')
-    .description('Manage template cache')
-    .option('--clear', 'Clear all cached templates')
+    .command("cache")
+    .description("Manage template cache")
+    .option("--clear", "Clear all cached templates")
     .action(templateCacheCommand);
 
   try {
     await program.parseAsync(process.argv);
   } catch (error) {
-    console.error(pc.red('Error:'), error.message);
+    console.error(pc.red("Error:"), error.message);
     process.exit(1);
   }
 }
diff --git a/src/core/config.js b/src/core/config.js
@@ -3,19 +3,59 @@ const { readFile, writeFile } = pkg;
 import { join } from "path";
 
 export async function generateConfig(projectDir, options) {
-  const { baseUrl } = options;
+  const {
+    baseUrl,
+    name,
+    description,
+    primaryColor,
+    accentColor,
+    favicon,
+    logo,
+  } = options;
 
-  // Only modify if base URL is not default
+  // Update docs-config.json with metadata and theme options
+  const configPath = join(projectDir, "docs-config.json");
+  let config = JSON.parse(await readFile(configPath, "utf-8"));
+
+  // Update metadata
+  if (name) {
+    config.metadata = config.metadata || {};
+    config.metadata.name = name;
+  }
+
+  if (description) {
+    config.metadata = config.metadata || {};
+    config.metadata.description = description;
+  }
+
+  // Update theme colors
+  if (primaryColor || accentColor) {
+    config.theme = config.theme || {};
+    if (primaryColor) config.theme.primaryColor = primaryColor;
+    if (accentColor) config.theme.accentColor = accentColor;
+  }
+
+  // Update branding
+  if (favicon || logo) {
+    config.branding = config.branding || {};
+    if (favicon) config.branding.favicon = favicon;
+    if (logo) config.branding.logo = config.branding.logo || {};
+    if (logo) config.branding.logo.src = logo;
+  }
+
+  await writeFile(configPath, JSON.stringify(config, null, 2), "utf-8");
+
+  // Update astro.config.mjs with base URL if needed
   if (baseUrl && baseUrl !== "/") {
-    const configPath = join(projectDir, "astro.config.mjs");
-    let content = await readFile(configPath, "utf-8");
+    const astroConfigPath = join(projectDir, "astro.config.mjs");
+    let content = await readFile(astroConfigPath, "utf-8");
 
     // Add base option to defineConfig
     content = content.replace(
       "export default defineConfig({",
       `export default defineConfig({\n  base: '${baseUrl}',`
     );
 
-    await writeFile(configPath, content, "utf-8");
+    await writeFile(astroConfigPath, content, "utf-8");
   }
 }

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-node_modules/`
	`1`	`+node_modules`
`2`	`2`	`dist/`
`3`	`3`	`.DS_Store`
`4`	`4`	`*.log`