@knowcode/doc-builder 1.1.3 → 1.1.5

package/CHANGELOG.md

@@ -5,6 +5,36 @@ 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.5] - 2025-01-19
+
+### Added
+- Clear explanation of Vercel URLs after deployment
+- Shows permanent production URL (e.g., gasworld.vercel.app)
+- Explains the difference between production and preview URLs
+- Better post-deployment messaging
+
+### Improved
+- Deployment success message now shows both URLs clearly
+- Production URL is highlighted as the one to share
+- Preview URL is explained as deployment-specific
+
+## [1.1.4] - 2025-01-19
+
+### Fixed
+- Removed deprecated --no-clipboard option
+- Fixed 404 errors with better index.html handling
+- Added fallback index.html when README.html doesn't exist
+- Production deployment now correctly uses --prod flag
+
+### Added
+- Auto-generated index.html with file listing if no README
+- Better logging during deployment preparation
+- Console messages when creating index.html
+
+### Changed
+- Simplified deployment arguments
+- Cleaner deployment command without unnecessary flags
+
 ## [1.1.3] - 2025-01-19
 
 ### Fixed

package/cli.js

@@ -319,7 +319,28 @@ ${chalk.yellow('Troubleshooting:')}
       // 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)}`);
+      spinner.succeed(`Deployed successfully!`);
+      
+      // Extract project name from URL
+      const projectName = url.match(/https:\/\/([^-]+)/)?.[1] || 'your-project';
+      
+      console.log(chalk.green('\n✅ Deployment Complete!\n'));
+      
+      if (isProduction) {
+        console.log(chalk.yellow('🌐 Your documentation is live at:'));
+        console.log(chalk.cyan.bold(`   ${projectName}.vercel.app`) + chalk.gray(' (Production URL - share this!)'));
+        console.log();
+        console.log(chalk.gray('This deployment also created a unique preview URL:'));
+        console.log(chalk.gray(`   ${url}`));
+        console.log(chalk.gray('   (This URL is specific to this deployment)'));
+      } else {
+        console.log(chalk.yellow('🔍 Preview deployment created at:'));
+        console.log(chalk.cyan(`   ${url}`));
+        console.log();
+        console.log(chalk.gray('To deploy to production, run:'));
+        console.log(chalk.gray('   npx @knowcode/doc-builder deploy'));
+      }
+      console.log();
       
     } catch (error) {
       spinner.fail('Deployment failed');
@@ -510,7 +531,19 @@ program
       
       // Default to production deployment
       const url = await deployToVercel(config, true);
-      deploySpinner.succeed(`Deployed successfully! ${chalk.cyan(url)}`);
+      deploySpinner.succeed(`Deployed successfully!`);
+      
+      // Extract project name from URL
+      const projectName = url.match(/https:\/\/([^-]+)/)?.[1] || 'your-project';
+      
+      console.log(chalk.green('\n✅ Deployment Complete!\n'));
+      console.log(chalk.yellow('🌐 Your documentation is live at:'));
+      console.log(chalk.cyan.bold(`   ${projectName}.vercel.app`) + chalk.gray(' (Production URL - share this!)'));
+      console.log();
+      console.log(chalk.gray('This deployment also created a unique preview URL:'));
+      console.log(chalk.gray(`   ${url}`));
+      console.log(chalk.gray('   (This URL is specific to this deployment)'));
+      console.log();
       
     } catch (error) {
       console.error(chalk.red('\nError: ' + error.message));

package/lib/deploy.js

@@ -187,11 +187,7 @@ async function deployToVercel(config, isProd = false) {
   }
   
   // Deploy command with explicit build settings
-  // Override any project settings that might be causing issues
-  const deployArgs = [
-    '--build-env', 'VERCEL_BUILD_OUTPUT_DIRECTORY=.',
-    '--no-clipboard'
-  ];
+  const deployArgs = [];
   
   if (isProd) {
     deployArgs.push('--prod');
@@ -299,7 +295,7 @@ async function prepareDeployment(config) {
   if (!fs.existsSync(indexPath)) {
     const readmePath = path.join(outputDir, 'README.html');
     if (fs.existsSync(readmePath)) {
-      // Create redirect
+      // Create redirect to README.html
       const redirectHtml = `<!DOCTYPE html>
 <html>
 <head>
@@ -311,6 +307,37 @@ async function prepareDeployment(config) {
 </body>
 </html>`;
       fs.writeFileSync(indexPath, redirectHtml);
+      console.log(chalk.green('✅ Created index.html redirect to README.html'));
+    } else {
+      // If no README.html, create a basic index listing all HTML files
+      const htmlFiles = fs.readdirSync(outputDir)
+        .filter(file => file.endsWith('.html') && file !== 'index.html')
+        .sort();
+      
+      if (htmlFiles.length > 0) {
+        const indexHtml = `<!DOCTYPE html>
+<html>
+<head>
+  <title>Documentation</title>
+  <style>
+    body { font-family: -apple-system, sans-serif; max-width: 800px; margin: 40px auto; padding: 0 20px; }
+    h1 { color: #333; }
+    ul { list-style: none; padding: 0; }
+    li { margin: 10px 0; }
+    a { color: #0066cc; text-decoration: none; }
+    a:hover { text-decoration: underline; }
+  </style>
+</head>
+<body>
+  <h1>Documentation</h1>
+  <ul>
+    ${htmlFiles.map(file => `<li><a href="${file}">${file.replace('.html', '')}</a></li>`).join('\n    ')}
+  </ul>
+</body>
+</html>`;
+        fs.writeFileSync(indexPath, indexHtml);
+        console.log(chalk.green('✅ Created index.html with file listing'));
+      }
     }
   }
 }

package/package.json

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