@knowcode/doc-builder 1.0.11 → 1.1.1

package/CHANGELOG.md

@@ -5,6 +5,37 @@ All notable changes to @knowcode/doc-builder 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).
 
+## [1.1.1] - 2025-01-19
+
+### Added
+- TL;DR section at the top of CLI help for quick understanding
+- Clear production deployment behavior explanation in help
+- Visual indicators for v1.1.0+ deployment changes
+- Examples showing production URLs vs preview URLs
+
+### Improved
+- Help text now prominently shows default production deployment
+- Added emoji and color highlights for important changes
+- Clearer deployment behavior section
+
+## [1.1.0] - 2025-01-19
+
+### Changed (BREAKING)
+- **Deploy command now defaults to production deployment**
+- Use `--no-prod` flag for preview deployments
+- Default action (no command) deploys to production
+- This ensures documentation is always published to main URL
+
+### Updated
+- All help text and examples reflect production default
+- CLI description clarifies production deployment
+- Example files use simplified deploy command
+
+### Migration
+- Previous: `npx @knowcode/doc-builder deploy --prod`
+- Now: `npx @knowcode/doc-builder deploy`
+- For preview: `npx @knowcode/doc-builder deploy --no-prod`
+
 ## [1.0.11] - 2025-01-19
 
 ### Added

package/cli.js

@@ -27,11 +27,16 @@ program
   .addHelpText('before', `
 ${chalk.cyan('🚀 @knowcode/doc-builder')} - Transform your markdown into beautiful documentation sites
 
+${chalk.bgGreen.black(' TL;DR ')} ${chalk.green('Just run:')} ${chalk.cyan.bold('npx @knowcode/doc-builder')} ${chalk.green('→ Your docs are live on Vercel!')}
+
+${chalk.gray('━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━')}
+
 ${chalk.yellow('What it does:')}
   • Converts markdown files to static HTML with a beautiful Notion-inspired theme
   • Automatically generates navigation from your folder structure
   • Supports mermaid diagrams, syntax highlighting, and dark mode
   • Deploys to Vercel with one command (zero configuration)
+  • ${chalk.green.bold('NEW:')} Deploys directly to production by default (v1.1.0+)
   • Optional authentication to protect private documentation
 
 ${chalk.yellow('Requirements:')}
@@ -45,7 +50,7 @@ ${chalk.yellow('Quick Start:')}
      ${chalk.gray('$')} echo "# My Documentation" > docs/README.md
   
   ${chalk.cyan('2. Build and deploy:')}
-     ${chalk.gray('$')} npx @knowcode/doc-builder              ${chalk.gray('# Build and deploy to Vercel')}
+     ${chalk.gray('$')} npx @knowcode/doc-builder              ${chalk.gray('# Build and deploy to production')}
      ${chalk.gray('   or')}
      ${chalk.gray('$')} npx @knowcode/doc-builder build        ${chalk.gray('# Build HTML files only')}
      ${chalk.gray('$')} npx @knowcode/doc-builder dev          ${chalk.gray('# Start development server')}
@@ -116,15 +121,15 @@ ${chalk.yellow('Examples:')}
 // Deploy command
 program
   .command('deploy')
-  .description('Deploy documentation to Vercel (requires Vercel CLI)')
+  .description('Deploy documentation to Vercel production (requires Vercel CLI)')
   .option('-c, --config <path>', 'path to config file (default: doc-builder.config.js)')
-  .option('--prod', 'deploy to production (default: preview deployment)')
+  .option('--no-prod', 'deploy as preview instead of production')
   .option('--no-build', 'skip building before deployment')
   .option('--force', 'force deployment without confirmation')
   .addHelpText('after', `
 ${chalk.yellow('Examples:')}
-  ${chalk.gray('$')} doc-builder deploy                 ${chalk.gray('# Deploy preview to Vercel')}
-  ${chalk.gray('$')} doc-builder deploy --prod          ${chalk.gray('# Deploy to production')}
+  ${chalk.gray('$')} doc-builder deploy                 ${chalk.gray('# Deploy to production')}
+  ${chalk.gray('$')} doc-builder deploy --no-prod       ${chalk.gray('# Deploy preview only')}
   ${chalk.gray('$')} doc-builder deploy --no-build      ${chalk.gray('# Deploy existing build')}
 
 ${chalk.yellow('First-time Vercel Setup:')}
@@ -183,9 +188,12 @@ ${chalk.yellow('First-time Vercel Setup:')}
      • Under "Deployment Protection", set to ${chalk.yellow('Disabled')}
      • This allows public access to your docs
      
-${chalk.yellow('Subsequent Deployments:')}
-  ${chalk.gray('$')} npx @knowcode/doc-builder          ${chalk.gray('# Deploy preview')}
-  ${chalk.gray('$')} npx @knowcode/doc-builder deploy --prod  ${chalk.gray('# Deploy to production')}
+${chalk.yellow('Deployment Behavior (v1.1.0+):')}
+  ${chalk.green.bold('🎯 DEFAULT: All deployments go to PRODUCTION')}
+  
+  ${chalk.gray('$')} npx @knowcode/doc-builder          ${chalk.gray('# → yourdocs.vercel.app')}
+  ${chalk.gray('$')} npx @knowcode/doc-builder deploy   ${chalk.gray('# → yourdocs.vercel.app')}
+  ${chalk.gray('$')} npx @knowcode/doc-builder deploy --no-prod  ${chalk.gray('# → preview URL only')}
 
 ${chalk.yellow('When All Else Fails - Delete and Start Fresh:')}
   Sometimes the cleanest solution is to delete the Vercel project:
@@ -308,7 +316,9 @@ ${chalk.yellow('Troubleshooting:')}
       }
       
       spinner.start('Deploying to Vercel...');
-      const url = await deployToVercel(config, options.prod);
+      // Default to production deployment
+      const isProduction = options.prod !== false;  // Default true unless explicitly --no-prod
+      const url = await deployToVercel(config, isProduction);
       spinner.succeed(`Deployed successfully! ${chalk.cyan(url)}`);
       
     } catch (error) {
@@ -422,7 +432,7 @@ ${chalk.yellow('What gets created:')}
         // Create example files
         const exampleFiles = {
           'README.md': `# Welcome to Your Documentation\n\nThis is an example documentation site created with @knowcode/doc-builder.\n\n## Features\n\n- 📝 Write in Markdown\n- 🎨 Beautiful Notion-inspired design\n- 📊 Mermaid diagram support\n- 🌙 Dark mode\n- 🚀 Deploy to Vercel\n\n## Getting Started\n\n1. Edit this file and add your content\n2. Create new markdown files\n3. Run \`npx @knowcode/doc-builder\` to build and deploy\n\n## Example Diagram\n\n\`\`\`mermaid\ngraph TD\n    A[Write Docs] --> B[Build]\n    B --> C[Deploy]\n    C --> D[Share]\n\`\`\`\n`,
-          'getting-started.md': `# Getting Started\n\n**Generated**: ${new Date().toISOString().split('T')[0]}\n**Status**: Draft\n**Verified**: ❓\n\n## Overview\n\nThis guide will help you get started with your documentation.\n\n## Installation\n\nNo installation required! Just use:\n\n\`\`\`bash\nnpx @knowcode/doc-builder\n\`\`\`\n\n## Writing Documentation\n\n1. Create markdown files in the \`docs\` folder\n2. Use folders to organize your content\n3. Add front matter for metadata\n\n## Building\n\nTo build your documentation:\n\n\`\`\`bash\nnpx @knowcode/doc-builder build\n\`\`\`\n\n## Deployment\n\nDeploy to Vercel:\n\n\`\`\`bash\nnpx @knowcode/doc-builder deploy --prod\n\`\`\`\n`,
+          'getting-started.md': `# Getting Started\n\n**Generated**: ${new Date().toISOString().split('T')[0]}\n**Status**: Draft\n**Verified**: ❓\n\n## Overview\n\nThis guide will help you get started with your documentation.\n\n## Installation\n\nNo installation required! Just use:\n\n\`\`\`bash\nnpx @knowcode/doc-builder\n\`\`\`\n\n## Writing Documentation\n\n1. Create markdown files in the \`docs\` folder\n2. Use folders to organize your content\n3. Add front matter for metadata\n\n## Building\n\nTo build your documentation:\n\n\`\`\`bash\nnpx @knowcode/doc-builder build\n\`\`\`\n\n## Deployment\n\nDeploy to Vercel:\n\n\`\`\`bash\nnpx @knowcode/doc-builder deploy\n\`\`\`\n`,
           'guides/configuration.md': `# Configuration Guide\n\n**Generated**: ${new Date().toISOString().split('T')[0]}\n**Status**: Draft\n**Verified**: ❓\n\n## Overview\n\n@knowcode/doc-builder works with zero configuration, but you can customize it.\n\n## Configuration File\n\nCreate \`doc-builder.config.js\`:\n\n\`\`\`javascript\nmodule.exports = {\n  siteName: 'My Documentation',\n  siteDescription: 'Documentation for my project',\n  \n  features: {\n    authentication: false,\n    changelog: true,\n    mermaid: true,\n    darkMode: true\n  }\n};\n\`\`\`\n\n## Options\n\n### Site Information\n\n- \`siteName\`: Your documentation site name\n- \`siteDescription\`: Brief description\n\n### Directories\n\n- \`docsDir\`: Input directory (default: 'docs')\n- \`outputDir\`: Output directory (default: 'html')\n\n### Features\n\n- \`authentication\`: Enable password protection\n- \`changelog\`: Generate changelog automatically\n- \`mermaid\`: Support for diagrams\n- \`darkMode\`: Dark theme support\n`
         };
         
@@ -452,8 +462,8 @@ ${chalk.yellow('What gets created:')}
 // Add a default command handler for when doc-builder is run without arguments
 program
   .action(async () => {
-    // Default action is build + deploy
-    console.log(chalk.cyan('\n🚀 Building and deploying your documentation...\n'));
+    // Default action is build + deploy to production
+    console.log(chalk.cyan('\n🚀 Building and deploying your documentation to production...\n'));
     
     try {
       // Build first
@@ -498,7 +508,8 @@ program
         deploySpinner.start('Deploying to Vercel...');
       }
       
-      const url = await deployToVercel(config, false);
+      // Default to production deployment
+      const url = await deployToVercel(config, true);
       deploySpinner.succeed(`Deployed successfully! ${chalk.cyan(url)}`);
       
     } catch (error) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@knowcode/doc-builder",
-  "version": "1.0.11",
+  "version": "1.1.1",
   "description": "Reusable documentation builder for markdown-based sites with Vercel deployment support",
   "main": "index.js",
   "bin": {