botdocs 0.1.0 → 0.2.0

package/README.md

@@ -1,5 +1,7 @@
 # Botdocs
 
+[![npm version](https://img.shields.io/npm/v/botdocs.svg)](https://www.npmjs.com/package/botdocs)
+
 Convert markdown documentation into beautiful static sites with AI-powered semantic search — no backend required.
 
 ## Features
@@ -33,8 +35,35 @@ botdocs ./docs -o ./public
 
 # Verbose logging
 botdocs ./docs -v
+
+# Use a specific theme
+botdocs ./docs -t material
+
+# Custom config file
+botdocs ./docs -c ./my-config.json
+
+# Combine multiple options
+botdocs ./docs -o ./public -t slate -v
 ```
 
+### CLI Options
+
+| Option | Alias | Description | Default |
+|--------|-------|-------------|---------|
+| `--output <dir>` | `-o` | Output directory for generated site | `output` |
+| `--no-chat` | | Disable AI chatbot functionality | `false` |
+| `--config <file>` | `-c` | Path to config file | `botdocs.config.json` |
+| `--theme <theme>` | `-t` | Theme to use | `classic` |
+| `--verbose` | `-v` | Enable verbose logging | `false` |
+
+### Available Themes
+
+- **classic** - Clean, professional theme (default)
+- **material** - Material Design theme
+- **minimal** - Clean, minimalist theme
+- **slate** - Dark slate theme
+- **modern** - Modern documentation theme
+
 ## Configuration
 
 Create `botdocs.config.json` in your docs directory:
@@ -43,15 +72,31 @@ Create `botdocs.config.json` in your docs directory:
 {
   "title": "My Documentation",
   "description": "Project docs",
+  "theme": "classic",
+  "attribution": true,
   "chat": { "enabled": true },
   "build": {
     "chunkSize": 500,
     "chunkOverlap": 50,
-    "topK": 5
+    "topK": 3
   }
 }
 ```
 
+### Configuration Options
+
+| Option | Type | Default | Description |
+|--------|------|---------|-------------|
+| `title` | string | `"Documentation"` | Site title |
+| `description` | string | `"Project documentation"` | Site description |
+| `theme` | string | `"classic"` | Theme to use (classic, material, minimal, slate, modern) |
+| `attribution` | boolean | `true` | Show "Built with Botdocs" footer link |
+| `chat.enabled` | boolean | `true` | Enable AI chatbot |
+| `chat.welcomeMessage` | string | `"Ask me anything about the docs!"` | Chatbot welcome message |
+| `build.chunkSize` | number | `500` | Text chunk size for embeddings |
+| `build.chunkOverlap` | number | `50` | Overlap between chunks |
+| `build.topK` | number | `3` | Number of results to return |
+
 ## Front Matter
 
 ```markdown

package/dist/src/builder/index.js

@@ -1,8 +1,7 @@
 import { defaultConfig } from '../types/config.js';
 import { SiteGenerator } from './site-generator.js';
 import { VectorDBBuilder } from './vector-db-builder.js';
-import { existsSync, readFileSync, writeFileSync, copyFileSync } from 'fs';
-import fs from 'fs-extra';
+import { existsSync, readFileSync, writeFileSync, copyFileSync, mkdirSync, cpSync } from 'fs';
 import { join, dirname, resolve } from 'path';
 import { fileURLToPath } from 'url';
 import { exec } from 'child_process';
@@ -14,7 +13,7 @@ const __dirname = dirname(__filename);
  * Main build orchestrator
  */
 export async function build(options) {
-    const { inputDir, outputDir, chatEnabled, configPath, verbose } = options;
+    const { inputDir, outputDir, chatEnabled, configPath, verbose, theme } = options;
     // Validate input directory
     if (!existsSync(inputDir)) {
         throw new Error(`Input directory does not exist: ${inputDir}`);
@@ -26,11 +25,15 @@ export async function build(options) {
         config.chat = config.chat || {};
         config.chat.enabled = chatEnabled;
     }
+    // Override theme if specified in CLI
+    if (theme) {
+        config.theme = theme;
+    }
     if (verbose) {
         console.log('Configuration:', JSON.stringify(config, null, 2));
     }
     // Prepare output directory
-    fs.ensureDirSync(outputDir);
+    mkdirSync(outputDir, { recursive: true });
     if (verbose) {
         console.log(`Cleaning output directory: ${outputDir}`);
     }
@@ -40,8 +43,8 @@ export async function build(options) {
     const documents = await generator.generate(inputDir, outputDir, config);
     // Create assets directories
     const assetsDir = join(outputDir, 'assets');
-    fs.ensureDirSync(join(assetsDir, 'css'));
-    fs.ensureDirSync(join(assetsDir, 'js'));
+    mkdirSync(join(assetsDir, 'css'), { recursive: true });
+    mkdirSync(join(assetsDir, 'js'), { recursive: true });
     if (verbose) {
         console.log(`Processed ${documents.length} documents`);
     }
@@ -85,7 +88,7 @@ export async function build(options) {
             const distAssetsDir = join(distClientDir, 'assets');
             if (existsSync(distAssetsDir)) {
                 const outputAssetsDir = join(jsOutputDir, 'assets');
-                fs.copySync(distAssetsDir, outputAssetsDir);
+                cpSync(distAssetsDir, outputAssetsDir, { recursive: true });
                 if (verbose) {
                     console.log('Copied code-split chunks');
                 }
@@ -108,9 +111,12 @@ export async function build(options) {
     console.log('Copying styles...');
     // From dist/src/builder, go to project root, then to src/styles
     const stylesDir = resolve(__dirname, '../../../src/styles');
+    const themesDir = join(stylesDir, 'themes');
     const outputCssDir = join(assetsDir, 'css');
-    // Combine all CSS files into one bundle
-    const cssFiles = ['main.css', 'themes.css', 'chat.css'];
+    // Determine which theme to use
+    const selectedTheme = config.theme || defaultConfig.theme || 'classic';
+    // Combine CSS files: base styles + selected theme + chat
+    const cssFiles = ['themes.css', 'chat.css'];
     let bundledCss = '';
     for (const cssFile of cssFiles) {
         const cssPath = join(stylesDir, cssFile);
@@ -118,6 +124,21 @@ export async function build(options) {
             bundledCss += readFileSync(cssPath, 'utf-8') + '\n\n';
         }
     }
+    // Add selected theme CSS
+    const themePath = join(themesDir, `${selectedTheme}.css`);
+    if (existsSync(themePath)) {
+        bundledCss += readFileSync(themePath, 'utf-8') + '\n\n';
+        if (verbose) {
+            console.log(`Using theme: ${selectedTheme}`);
+        }
+    }
+    else {
+        console.warn(`Theme '${selectedTheme}' not found, falling back to classic`);
+        const fallbackPath = join(themesDir, 'classic.css');
+        if (existsSync(fallbackPath)) {
+            bundledCss += readFileSync(fallbackPath, 'utf-8') + '\n\n';
+        }
+    }
     writeFileSync(join(outputCssDir, 'bundle.css'), bundledCss, 'utf-8');
     if (verbose) {
         console.log('Styles copied');

package/dist/src/builder/site-generator.js

@@ -1,6 +1,4 @@
-import { glob } from 'glob';
-import { readFileSync, writeFileSync } from 'fs';
-import fs from 'fs-extra';
+import { readFileSync, writeFileSync, readdirSync, mkdirSync, cpSync } from 'fs';
 import { join, dirname, resolve } from 'path';
 import { MarkdownProcessor } from './markdown-processor.js';
 import { TemplateEngine } from './template-engine.js';
@@ -20,12 +18,16 @@ export class SiteGenerator {
      */
     async generate(inputDir, outputDir, config) {
         console.log('Processing markdown files...');
-        // Find all markdown files
-        const markdownFiles = await glob('**/*.md', {
-            cwd: inputDir,
-            absolute: true,
-            ignore: ['node_modules/**', '**/node_modules/**'],
+        // Find all markdown files using native Node.js readdir
+        const allFiles = readdirSync(inputDir, {
+            recursive: true,
+            withFileTypes: true
         });
+        const markdownFiles = allFiles
+            .filter(dirent => dirent.isFile() &&
+            dirent.name.endsWith('.md') &&
+            !dirent.parentPath.includes('node_modules'))
+            .map(dirent => join(dirent.parentPath || dirent.path, dirent.name));
         if (markdownFiles.length === 0) {
             throw new Error(`No markdown files found in ${inputDir}`);
         }
@@ -90,10 +92,11 @@ export class SiteGenerator {
                 content,
                 navigation: this.renderNavigation(navigation, doc.url),
                 chatEnabled: config.chat?.enabled,
+                attribution: config.attribution !== false, // defaults to true
             });
             // Write HTML file
             const outputPath = join(outputDir, doc.relativePath.replace(/\.md$/, '.html'));
-            fs.ensureDirSync(dirname(outputPath));
+            mkdirSync(dirname(outputPath), { recursive: true });
             writeFileSync(outputPath, html, 'utf-8');
         }
         // Copy index.html if README.md exists
@@ -102,7 +105,7 @@ export class SiteGenerator {
             const readmePath = join(outputDir, readmeDoc.relativePath.replace(/\.md$/, '.html'));
             const indexPath = join(outputDir, 'index.html');
             if (readmePath !== indexPath) {
-                fs.copySync(readmePath, indexPath);
+                cpSync(readmePath, indexPath);
             }
         }
         console.log(`Generated ${this.documents.length} HTML pages`);

package/dist/src/cli/index.js

@@ -18,6 +18,7 @@ program
     .option('-o, --output <dir>', 'Output directory for generated site', defaultOptions.output)
     .option('--no-chat', 'Disable AI chatbot functionality')
     .option('-c, --config <file>', 'Path to config file (botdocs.config.json)')
+    .option('-t, --theme <theme>', 'Theme to use (classic, material, minimal, slate, modern)', defaultOptions.theme)
     .option('-v, --verbose', 'Enable verbose logging')
     .action(async (input, options) => {
     try {
@@ -28,6 +29,7 @@ program
             console.log(`Input: ${inputDir}`);
             console.log(`Output: ${outputDir}`);
             console.log(`Chat enabled: ${!options.noChat}`);
+            console.log(`Theme: ${options.theme || defaultOptions.theme}`);
         }
         await build({
             inputDir,
@@ -35,6 +37,7 @@ program
             chatEnabled: !options.noChat,
             configPath: options.config,
             verbose: options.verbose || false,
+            theme: options.theme,
         });
         console.log('Build complete!');
         console.log(`Site generated at: ${outputDir}`);

package/dist/src/cli/options.d.ts

@@ -1,7 +1,9 @@
+export type Theme = 'classic' | 'material' | 'minimal' | 'slate' | 'modern';
 export interface CliOptions {
     output?: string;
     noChat?: boolean;
     config?: string;
     verbose?: boolean;
+    theme?: Theme;
 }
 export declare const defaultOptions: Partial<CliOptions>;

package/dist/src/cli/options.js

@@ -2,4 +2,5 @@ export const defaultOptions = {
     output: 'output',
     noChat: false,
     verbose: false,
+    theme: 'classic',
 };

package/dist/src/types/config.d.ts

@@ -1,9 +1,9 @@
+export type Theme = 'classic' | 'material' | 'minimal' | 'slate' | 'modern';
 export interface BotdocsConfig {
     title?: string;
     description?: string;
-    theme?: {
-        primaryColor?: string;
-    };
+    theme?: Theme;
+    attribution?: boolean;
     chat?: {
         enabled?: boolean;
         welcomeMessage?: string;
@@ -20,5 +20,6 @@ export interface BuildOptions {
     chatEnabled: boolean;
     configPath?: string;
     verbose: boolean;
+    theme?: Theme;
 }
 export declare const defaultConfig: BotdocsConfig;

package/dist/src/types/config.js

@@ -1,9 +1,8 @@
 export const defaultConfig = {
     title: 'Documentation',
     description: 'Project documentation',
-    theme: {
-        primaryColor: '#3b82f6',
-    },
+    theme: 'classic',
+    attribution: true,
     chat: {
         enabled: true,
         welcomeMessage: 'Ask me anything about the docs!',
@@ -11,6 +10,6 @@ export const defaultConfig = {
     build: {
         chunkSize: 500,
         chunkOverlap: 50,
-        topK: 5,
+        topK: 3,
     },
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "botdocs",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "An npm CLI tool that converts markdown documentation into a static website with an optional client-side AI chatbot",
   "author": "usr-wwelsh <https://wwel.sh>",
   "license": "MIT",
@@ -38,8 +38,6 @@
     "@shikijs/markdown-it": "^1.0.0",
     "@xenova/transformers": "^2.17.0",
     "commander": "^12.0.0",
-    "fs-extra": "^11.2.0",
-    "glob": "^11.0.0",
     "gray-matter": "^4.0.3",
     "markdown-it": "^14.0.0",
     "markdown-it-anchor": "^9.0.0",
@@ -53,8 +51,7 @@
     "shiki": "^1.0.0"
   },
   "devDependencies": {
-    "@types/fs-extra": "^11.0.4",
-    "@types/markdown-it": "^13.0.0",
+    "@types/markdown-it": "^14.0.0",
     "@types/node": "^20.11.0",
     "terser": "^5.36.0",
     "typescript": "^5.3.0",

package/src/styles/main.css

@@ -503,6 +503,29 @@ img {
   font-size: 0.875rem;
 }
 
+/* Footer Attribution */
+.botdocs-attribution {
+  margin-top: 4rem;
+  padding-top: 2rem;
+  border-top: 1px solid var(--border-color);
+  text-align: center;
+  font-size: 0.875rem;
+  color: var(--text-secondary);
+  opacity: 0.8;
+}
+
+.botdocs-attribution a {
+  color: var(--text-secondary);
+  text-decoration: none;
+  font-weight: 500;
+  transition: color 0.2s;
+}
+
+.botdocs-attribution a:hover {
+  color: var(--link-color);
+  text-decoration: none;
+}
+
 /* Responsive */
 @media (max-width: 768px) {
   .sidebar {