@knowcode/doc-builder 1.1.4 → 1.1.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/CHANGELOG.md +13 -0
  2. package/cli.js +35 -2
  3. package/package.json +1 -1
package/CHANGELOG.md CHANGED
@@ -5,6 +5,19 @@ All notable changes to @knowcode/doc-builder will be documented in this file.
5
5
  The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
6
6
  and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7
7
 
8
+ ## [1.1.5] - 2025-01-19
9
+
10
+ ### Added
11
+ - Clear explanation of Vercel URLs after deployment
12
+ - Shows permanent production URL (e.g., gasworld.vercel.app)
13
+ - Explains the difference between production and preview URLs
14
+ - Better post-deployment messaging
15
+
16
+ ### Improved
17
+ - Deployment success message now shows both URLs clearly
18
+ - Production URL is highlighted as the one to share
19
+ - Preview URL is explained as deployment-specific
20
+
8
21
  ## [1.1.4] - 2025-01-19
9
22
 
10
23
  ### Fixed
package/cli.js CHANGED
@@ -319,7 +319,28 @@ ${chalk.yellow('Troubleshooting:')}
319
319
  // Default to production deployment
320
320
  const isProduction = options.prod !== false; // Default true unless explicitly --no-prod
321
321
  const url = await deployToVercel(config, isProduction);
322
- spinner.succeed(`Deployed successfully! ${chalk.cyan(url)}`);
322
+ spinner.succeed(`Deployed successfully!`);
323
+
324
+ // Extract project name from URL
325
+ const projectName = url.match(/https:\/\/([^-]+)/)?.[1] || 'your-project';
326
+
327
+ console.log(chalk.green('\nāœ… Deployment Complete!\n'));
328
+
329
+ if (isProduction) {
330
+ console.log(chalk.yellow('🌐 Your documentation is live at:'));
331
+ console.log(chalk.cyan.bold(` ${projectName}.vercel.app`) + chalk.gray(' (Production URL - share this!)'));
332
+ console.log();
333
+ console.log(chalk.gray('This deployment also created a unique preview URL:'));
334
+ console.log(chalk.gray(` ${url}`));
335
+ console.log(chalk.gray(' (This URL is specific to this deployment)'));
336
+ } else {
337
+ console.log(chalk.yellow('šŸ” Preview deployment created at:'));
338
+ console.log(chalk.cyan(` ${url}`));
339
+ console.log();
340
+ console.log(chalk.gray('To deploy to production, run:'));
341
+ console.log(chalk.gray(' npx @knowcode/doc-builder deploy'));
342
+ }
343
+ console.log();
323
344
 
324
345
  } catch (error) {
325
346
  spinner.fail('Deployment failed');
@@ -510,7 +531,19 @@ program
510
531
 
511
532
  // Default to production deployment
512
533
  const url = await deployToVercel(config, true);
513
- deploySpinner.succeed(`Deployed successfully! ${chalk.cyan(url)}`);
534
+ deploySpinner.succeed(`Deployed successfully!`);
535
+
536
+ // Extract project name from URL
537
+ const projectName = url.match(/https:\/\/([^-]+)/)?.[1] || 'your-project';
538
+
539
+ console.log(chalk.green('\nāœ… Deployment Complete!\n'));
540
+ console.log(chalk.yellow('🌐 Your documentation is live at:'));
541
+ console.log(chalk.cyan.bold(` ${projectName}.vercel.app`) + chalk.gray(' (Production URL - share this!)'));
542
+ console.log();
543
+ console.log(chalk.gray('This deployment also created a unique preview URL:'));
544
+ console.log(chalk.gray(` ${url}`));
545
+ console.log(chalk.gray(' (This URL is specific to this deployment)'));
546
+ console.log();
514
547
 
515
548
  } catch (error) {
516
549
  console.error(chalk.red('\nError: ' + error.message));
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@knowcode/doc-builder",
3
- "version": "1.1.4",
3
+ "version": "1.1.5",
4
4
  "description": "Reusable documentation builder for markdown-based sites with Vercel deployment support",
5
5
  "main": "index.js",
6
6
  "bin": {